Move contributing guide details to website and rename two sections#1335
Move contributing guide details to website and rename two sections#1335
Conversation
willschlitzer
left a comment
There was a problem hiding this comment.
Looks good! I think this was a needed change.
core-man
left a comment
There was a problem hiding this comment.
Great~ I cannot see the Preview button right now, but it seems that the movement is smooth enough.
There was a problem hiding this comment.
Two points to consider:
- The third and fourth level section headings don't seem to be very clear on the rendered docs. Something about the sphinx theme maybe?
compared with the current CONTRIBUTING.md on GitHub which uses bold text.
- There is a "Contributing" link under "Getting Help and Contributing" on the sidebar which points to CONTRIBUTING.md on GitHub. Maybe the "Contributors Guide" (and "Maintainers Guide") should fit under there instead of under "Reference Documentation"? Or we can remove the link to CONTRIBUTING.md 🙂
P.S. Not sure why the "Show Deployment" button isn't showing up. But y'all can click on the Vercel deployment details under the checks section to get to the online rendered docs.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
I think this is a myst parser issue based on comparisons of the changelog when it was .rst versus .md. I assumed that people would prefer markdown over ReST, though it does not really matter to me either way. I would like to submit a separate PR with some more general suggestions for the contributing guide. Would it be OK to see about improving the rendering in that instead?
I'll remove the CONTRIBUTING.md link. Eventually, I would prefer for this to go under a development tab but will leave that change to be reviewed in #1308. |
…enericMappingTools#1335) * Move contributing guide details to website * Update doc/contributing.md Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> * Remove CONTRIBUTING.md from menu_links Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Description of proposed changes
This PR moves the detailed contributing sections to the website and renames two sections:
What can I do? -> Ways to Contribute
How can I talk to you? -> Getting Help
A shorter contributing guide with links to the website remains in root dir of the PyGMT repository.
Other suggested revisions will be submitted in a separate PR to keep changes isolated.
Fixes #1205
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version