Update contribution guidelines #4067
Conversation
NathanLovato
changed the title
|
It's ready to start reviewing. I split commits because the changes are a bit big. That way, you can look at each commit's changes separately. |
NathanLovato
force-pushed
the
content/writing-guidelines-updates
branch
from
39580fb to
4bdb829
Compare
|
Just updated the index.rst file, all planned changes are in! |
- Start with a short sentence describing the doc's content - Link to the translation docs - Remove section about translation - Many wording edits
- Wording updates - Separate writing guidelines for the class ref and git PR guide into - two pages
- Edited building_the_manual to make the content more explicit - Added some links to the README to help them get started contributing
NathanLovato
force-pushed
the
content/writing-guidelines-updates
branch
from
f6e059b to
deade79
Compare
Removed some typographic marks, fix missing newlines, phrasing... Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
|
Note I'm marking comments as resolved as I make changes locally, will push everything at once in a commit once done. |
Add links to the README Simplify building the manual Update class reference writing guidelines based on review notes. Re-add lost changes in rebase. Address review comments in documentation guidelines
We split some pages into two and some remaining references were leading to an irrelevant page.
|
Left:
|
NathanLovato
force-pushed
the
content/writing-guidelines-updates
branch
from
d643d3a to
87a8720
Compare
|
@akien-mga all changes are in. There was only one file left to rename. You may want to check the short index.rst to see if it's fine by you to merge. Regarding references, there might be opportunities to link to the index.rst's three reference links, but that would require reading around the documentation to add links that invite people to contribute. Inside the community/contributing section, I found the specific labels we have right now were relevant. Would you like to replace the bullet list in the readme maybe and link directly to the community/contributing/index page? |
|
I'll merge for now considering it's an improvement and I'm available if you need me to change anything. |
Closes #4065