Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation around the GPL license and implications for contribution #1776

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from

Conversation

n8finch
Copy link
Contributor

@n8finch n8finch commented Sep 17, 2024

Closes: #504

Motivation for the change, related issues

Adding documentation around the GPL license and implications for contribution.

Implementation details

Just updated the readme.

Testing Instructions (or ideally a Blueprint)

Run the build and checkout the readme at http://localhost:3000/wordpress-playground/contributing

@adamziel
Copy link
Collaborator

Looping in @juanmaguitar for reviews

Copy link
Collaborator

@sejas sejas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks great to me.

I've executed nvm use && npm i && pm run dev:docs
And I was able to access http://localhost:3000/wordpress-playground/contributing
I got an error, but I don't think it's not related to his PR.

ERROR in ./src/typedoc-model.ts 2:0-30
Module not found: Error: Can't resolve './model.json' in '/Users/macbookpro/Documents/projects-m3.nosync/wordpress-playground/packages/docs/site/src'
Screenshot 2024-09-17 at 11 43 49

I'm approving the PR. I would change the link to License, but happy to hear what other folks think about it.

packages/docs/site/docs/main/contributing/index.md Outdated Show resolved Hide resolved
@adamziel
Copy link
Collaborator

Thank you for contributing @n8finch! I've added a few suggestions but it LGTM otherwise.

n8finch and others added 2 commits September 24, 2024 08:45
Co-authored-by: Adam Zieliński <adam@adamziel.com>
Co-authored-by: Adam Zieliński <adam@adamziel.com>
@n8finch
Copy link
Contributor Author

n8finch commented Sep 24, 2024

@adamziel thanks for the review and suggestions, I've added them 🙂.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs review
Development

Successfully merging this pull request may close these issues.

Doc: Discuss GPL Licensing in the contributing document
3 participants