-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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 docs contribution checklist page #10170
base: master
Are you sure you want to change the base?
Conversation
5a33d67
to
2017152
Compare
Do you think that an even shorter version with section links should be incorporated into PR template as a checklist? Examples below. I'd say that this could help with discoverability for first-time users. I think that contributors who go and read the docs on their own will be fine. On the other hand, more procedures can be overwhelming and discourage people... Maybe a positive wording would mitigate that? Can you help our maintainers? Template as would be shown in the editor: **Can you help our maintainers?**
Change `[ ]` to `[x]` for guidelines you verified, or to `N/A` if they don't apply to your contribution.
- [ ] [Writing style](https://docs.godotengine.org/en/stable/contributing/documentation/contribution_checklist.html#writing-style)
- [ ] [Code examples](https://docs.godotengine.org/en/stable/contributing/documentation/contribution_checklist.html#code-examples)
- [ ] [Manual style and formatting](https://docs.godotengine.org/en/stable/contributing/documentation/contribution_checklist.html#manual-style-and-formatting)
- [ ] [Images and videos](https://docs.godotengine.org/en/stable/contributing/documentation/contribution_checklist.html#images-and-videos)
- [ ] [GitHub metadata](https://docs.godotengine.org/en/stable/contributing/documentation/contribution_checklist.html#github) |
In principle that's a good idea! I do have a few concerns:
At the very least I think we should add to the PR template a link to the checklist page as a whole; whether a full checklist is good to include is a good question. |
I think this is the most reasonable solution, I may have been overenthusiastic on my first two days being able to use the engine at work 😅 |
Resolves #9193.
This PR adds a new page to the
Writing documentation
section. It is a list of all of the content, style, and formatting guidelines that manual contributions are expected to follow. Each entry in the page concisely summarizes the guideline, then links to the section of docs that describes the guideline in full.It is intended to be used:
I kept the rules quite terse, since there are so many of them and they all link to longer versions. But I can expand them a little if it feels too terse.
If this ends up being used, possibly we will want an equivalent for engine PRs?