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

Restructure contributing.md to separate docs/general info from contributing code section #1339

Merged
merged 23 commits into from
Jul 15, 2021
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
1439365
Add more ways to contribute
maxrjones Jun 18, 2021
f59a314
Add Providing Feedback Section
maxrjones Jun 18, 2021
221ba34
Add General Guidelines section
maxrjones Jun 18, 2021
c6b8872
Organize documentation section
maxrjones Jun 18, 2021
1fe0d76
Format headers
maxrjones Jun 18, 2021
337d6a4
Apply suggestions from code review
maxrjones Jun 19, 2021
cc0b5cd
Clarify that conda env create uses environment.yml
maxrjones Jun 19, 2021
b88f185
Change building documentation section header to editing locally
maxrjones Jun 19, 2021
629daa7
Merge branch 'master' into contrib-guide
maxrjones Jun 19, 2021
a23e192
Apply suggestions from code review
maxrjones Jun 22, 2021
ceac21b
Move setting up your environment to separate section
maxrjones Jun 25, 2021
dbc7754
Use ordered list
maxrjones Jun 25, 2021
3a0ae7e
Organize ways to contribute in shorter lists
maxrjones Jun 25, 2021
b78cd87
Merge branch 'master' into contrib-guide
maxrjones Jun 25, 2021
c9ad300
Apply suggestions from code review
maxrjones Jun 28, 2021
8addf7a
Update contributing.md
maxrjones Jun 28, 2021
f9e6acc
Merge branch 'master' into contrib-guide
maxrjones Jul 2, 2021
6a867fb
Merge branch 'master' into contrib-guide
maxrjones Jul 8, 2021
71dd38c
Merge branch 'master' into contrib-guide
maxrjones Jul 12, 2021
82e04ec
Add hyperlinks
maxrjones Jul 12, 2021
e7357aa
Use bold format for section headers
maxrjones Jul 12, 2021
a760520
Do not bold first level header
maxrjones Jul 13, 2021
975777b
Update doc/contributing.md
maxrjones Jul 14, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add Providing Feedback Section
  • Loading branch information
maxrjones committed Jun 18, 2021
commit f59a314bc936ec906aa59530ee85dd8f073a7fd7
45 changes: 32 additions & 13 deletions doc/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,45 @@ and we encourage all to read it carefully.
announced on the [Forum governance page](https://forum.generic-mapping-tools.org/c/governance/9).
* Spread the word about PyGMT or star the project!

## Providing Feedback

### Reporting a Bug

* Find the [*Issues*]((https://github.com/GenericMappingTools/pygmt/issues)) tab on the
top of the GitHub repository and click *New Issue*.
* Click on *Get started* next to *Bug report*.
* **Please try to fill out the template with as much detail as you can**.
* After submitting your bug report, try to answer any follow up questions about the bug
as best as you can.

### Submitting a Feature Request

* Find the [*Issues*]((https://github.com/GenericMappingTools/pygmt/issues)) tab on the
top of the GitHub repository and click *New Issue*.
* Click on *Get started* next to *Feature request*.
* **Please try to fill out the template with as much detail as you can**.
* After submitting your feature request, try to answer any follow up questions as best
as you can.

### Submitting General Comments/Questions

There are several pages on the [Community Forum](https://forum.generic-mapping-tools.org/)
where you can submit general comments and/or questions:

* For questions about using PyGMT, select *New Topic* from the
[PyGMT Q&A Page](https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a/11).
* For general comments, select *New Topic* from the
[Lounge Page](https://forum.generic-mapping-tools.org/c/lounge/6).
* To share your work, select *New Topic* from the
[Showcase Page](https://forum.generic-mapping-tools.org/c/Sow-your-nice-example-script/10).

## Getting Help

Discussion often happens on GitHub issues and pull requests.
In addition, there is a
[Discourse forum](https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a) for
the project where you can ask questions.


## Reporting a Bug

Find the *Issues* tab on the top of the GitHub repository and click *New Issue*.
You'll be prompted to choose between different types of issue, like bug reports and
feature requests.
Choose the one that best matches your need.
The Issue will be populated with one of our templates.
**Please try to fillout the template with as much detail as you can**.
Remember: the more information we have, the easier it will be for us to solve your
problem.


## Editing the Documentation

If you're browsing the documentation and notice a typo or something that could be
Expand Down