Skip to content

DOC: Add notes for first-time contributors in CONTRIBUTING.md #4823

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.

Sign up for GitHub

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

Open
seisman wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −6
Open

DOC: Add notes for first-time contributors in CONTRIBUTING.md #4823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,32 @@ successful. These are some of the many ways to contribute:
* :people_holding_hands: Community engagement and outreach

If you get stuck at any point you can create an
[issue](https://github.com/GenericMappingTools/pygmt/issues) on GitHub
or contact us at one of the channels mentioned
in the [Contributing Guide](https://www.pygmt.org/dev/contributing.html).
[issue](https://github.com/GenericMappingTools/pygmt/issues) on GitHub or contact us at
one of the channels mentioned in the
[Contributing Guide](https://www.pygmt.org/dev/contributing.html).

For more information on contributing to open source projects,
[GitHub's own guide](https://opensource.guide/how-to-contribute)
is a great starting point if you are new to version control. Also, checkout the
[GitHub's own guide](https://opensource.guide/how-to-contribute) is a great starting
point if you are new to version control. Also, check out the
[Zen of Scientific Software Maintenance](https://jrleeman.github.io/ScientificSoftwareMaintenance/)
for some guiding principles on how to create high quality scientific software
contributions.


## Ground Rules

The goal is to maintain a diverse community that's pleasant for everyone.
**Please be considerate and respectful of others**. Everyone must abide by our
[Code of Conduct](https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md)
and we encourage all to read it carefully.

## First-Time Contributors

We welcome first-time contributors! If you are new to open source, we recommend starting
with a small contribution, such as fixing a typo or adding a simple example. We hope
that the contributing process will be a good experience for you. Please let us know if
there is any way that it could be improved. After your PR is merged, feel free to open a
new pull request to add yourself to the [`AUTHORS.md`](AUTHORS.md) file.

## Quick links

* [Ways to Contribute](https://www.pygmt.org/dev/contributing.html#ways-to-contribute)
Expand Down