Skip to content

Latest commit

 

History

History
122 lines (79 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

122 lines (79 loc) · 3.67 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/immcantation/amulety/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

AMULETY could always use more documentation, whether as part of the official AMULETY docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/immcantation/amulety/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome

Get Started!

Ready to contribute? Here's how to set up AMULETY for local development.

  1. Fork the AMULETY repo on GitHub.
  2. Clone your fork locally:
$ git clone [email protected]:<your_name_here>/amulety.git
  1. Install your local copy into a virtualenv or conda. Assuming you have conda installed, this is how you set up your fork for local development:
$ conda create -n amulety python=3.11
$ cd amulety/
$ pip install -e .
  1. Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. When you're done making changes, check that the linting tests pass:
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

Now pre-commit will run automatically on git commit!. If you want to run it manually run

$ pre-commit .
  1. Check that the tests pass locally, and add tests if necessary.
pytest .
  1. Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11, and for PyPy. Check https://github.com/immcantation/amulety/actions and make sure that the tests pass for all supported Python versions.
  4. Automatic GitHub actions CI tests will also run the tests, all the tests must pass before merging the PR.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

GitHub actions will then deploy to PyPI if tests pass.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.