Restructure contributing.md to separate docs/general info from contributing code section #1339
Conversation
Co-authored-by: Yao Jiayuan <[email protected]>
Co-authored-by: Yao Jiayuan <[email protected]>
|
Thanks for all the good recommendations @core-man. I tried to address them all in the latest round of commits. |
doc/contributing.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| # Contributors Guide | |||
| # **Contributors Guide** | |||
There was a problem hiding this comment.
It looks like this is causing the menu title to be bold; is that the intention?
There was a problem hiding this comment.
I bolded all the section headers in response to #1339 (comment) because the fourth level looked bad without any extra formatting and it looked odd to have only that level bolded. But since this shouldn't be the only level one header bolded in the toctree, I just removed the bold formatting for the first level header in a760520. Long term, the solution is probably to use ReST for the development pages on the website.
maxrjones
added
the
final review call
Co-authored-by: Dongdong Tian <[email protected]>
|
@weiji14, I would prefer to merge this now but want to check in with you first in case you have any objections to merging this update to the contributing docs before the SciPy sprint. Do you mind if I merge the PR? |
Nope, go ahead and merge please. I think it's best to have it done before the SciPy sprint tomorrow. |
seisman
removed
the
final review call
…buting code section (GenericMappingTools#1339) * Add more ways to contribute * Add Providing Feedback Section * Add General Guidelines section * Clarify that conda env create uses environment.yml * Change building documentation section header to editing locally * Move setting up your environment to separate section * Organize ways to contribute in shorter lists Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
Description of proposed changes
This PR restructures the contributing guide, motivated by the fact that some information helpful for all PRs was in the contributing code section.
This PR creates a separate General Guidelines section which includes:
It also moves the documentation focused sections 'building the documentation' and 'cross-referencing with sphinx' to the 'contributing documentation' section.
It also adds a few more options to 'ways to contribute'.
Lastly, it adds 'PyGMT Documentation Overview' and 'PyGMT Code Overview' to the start of 'Contributing Documentation' and 'Contributing Code' respectively.
Fixes #
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