pub_soft/apbs
3
0
Fork 0
mirror of https://github.com/Electrostatics/apbs.git synced 2026-06-04 12:44:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Nathan Baker
2021-03-29 19:22:29 -07:00
committed by GitHub
parent e9dcf0f894
commit ab7c6c1c85
1 changed files with 36 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,36 @@
# Contributing to APBS
We are excited to have you contribute to APBS!
If you have general questions about the code, please see the [documentation](https://apbs.readthedocs.io/en/latest/) and/or start a thread in the [discussion forum](https://github.com/Electrostatics/apbs/discussions).
Once you have familiarity with the code, you're ready to start contributing:
## Find or create a problem
Find a problem/feature that needs to be resolved in the code [issues](https://github.com/Electrostatics/apbs/issues).
If the problem you're trying to solve doesn't exist, create a Github issue to resolve some or all of the problem or to add features.
For example, you could
* Fix a bug
* Add a new capability with 3 parts - create issue for each part it possible
* In general, make problem/feature small enough to finish it within a week or two
## Create a branch
Create a git branch using the convention of `github_user`/`issue_#` where `github_user` is your user name and `issue_#` is the issue number from step 2 above.
## Create and pass tests
Create a test that replicates the problem/feature and fails and show how your fix results in a working test.
Work on the code until your test, as well as all previous tests, pass.
## Do not submit messy code
Run your code through formatting (e.g., [psf/black](https://github.com/psf/black)) and linting (e.g., [pylint](https://www.pylint.org/) and [flake8](https://flake8.pycqa.org/en/latest/)) tools appropriate to the language for your code.
## Submit a pull request
1. Commit your changes to Git and push your branch to the Github repo.
2. Create a [pull request](https://github.com/Electrostatics/apbs/compare?expand=1) and add reviewers (e.g., `intendo` or `sobolevnrm`) to the request.
[Reference the issue you are trying to fix](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) in your pull request.
3. If the pull request passes [Github Actions](https://github.com/features/actions) and peer review, then the branch will be merged with `main`, your branch will be deleted, and the development team will be very grateful for your contribution!
Thank you for considering to contribute to our code!