Skip to content

Commit

Permalink
update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
gboeing committed Dec 30, 2020
1 parent fcac75c commit 4336977
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
Thanks for using pynamical and for considering contributing to it!
# Pynamical contributing guidelines

Thanks for using Pynamical and for considering contributing to it by opening an issue or pull request.

#### If you have a "how-to" or usage question rather than a bug report or new feature proposal:

- please ask your question on [StackOverflow](https://stackoverflow.com/search?q=pynamical)

#### If you're having an installation problem:

- make sure you've followed the installation instructions in the [documentation](https://pynamical.readthedocs.io/)
- if you installed Pynamical via conda-forge, please open an issue at its [feedstock](https://github.com/conda-forge/pynamical-feedstock/issues)

#### If you've found a bug:

- read the error message and [documentation](https://pynamical.readthedocs.io/)
- search through the [open issues](https://github.com/gboeing/pynamical/issues?q=is%3Aopen+is%3Aissue) and [closed issues](https://github.com/gboeing/pynamical/issues?q=is%3Aissue+is%3Aclosed) first
- if the problem is with a dependency of this project, open an issue on the dependency's repo
- if the problem is with pynamical and you can fix it simply, please submit a PR
- if the problem persists, please open an issue in the [issue tracker](https://github.com/gboeing/pynamical/issues) filling out all sections of the template, including a minimal working example to reproduce the problem
- search through the [open issues](https://github.com/gboeing/pynamical/issues?q=is%3Aopen+is%3Aissue) and [closed issues](https://github.com/gboeing/pynamical/issues?q=is%3Aissue+is%3Aclosed) to see if it has already been reported
- if the problem is with a dependency of this project, open an issue in the dependency's repo
- if the problem is with Pynamical and you can fix it simply, please open a pull request
- if the problem persists, please open an issue in the [issue tracker](https://github.com/gboeing/pynamical/issues) filling out all sections of the template, including a minimal working example so others can independently and completely reproduce the problem

#### If you have a feature proposal or want to contribute:

- post your proposal on the [issue tracker](https://github.com/gboeing/pynamical/issues) so we can review it together (some proposals may not be a good fit for the project)
- fork the repo, make your change (adhering to pynamical's existing coding, commenting, and docstring styles), [test it](https://github.com/gboeing/pynamical/tree/master/tests), and submit a PR
- fork the repo, make your change, [test it](./tests), and submit a PR
- respond to code review

#### If this is a general/usage question (rather than a bug report or proposed PR):

- please ask your question on [StackOverflow](https://stackoverflow.com/search?q=pynamical)
- adhere to the following project standards
- `black` code style with max line length of 100
- `isort` sorted imports
- `numpy` style docstrings

Every piece of software is a work in progress. This project is the result of many hours of work contributed freely by myself and the many people that build the projects it depends on. Thank you for contributing!

0 comments on commit 4336977

Please sign in to comment.