Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways, for example:
Report bugs at https://github.com/pyopensci/pyos-package-template/issues.
If you are reporting a bug, please follow the template guidelines. The more detailed your report, the easier and thus faster we can help you.
Look through the GitHub issues for bugs. Anything labelled with bug and
help wanted is open to whoever wants to implement it. When you decide to work on such
an issue, please assign yourself to it and add a comment that you'll be working on that,
too. If you see another issue without the help wanted label, just post a comment, the
maintainers are usually happy for any support that they can get.
Look through the GitHub issues for features. Anything labelled with
enhancement and help wanted is open to whoever wants to implement it. As
for fixing bugs, please assign yourself to the issue and add a comment that
you'll be working on that, too. If another enhancement catches your fancy, but it
doesn't have the help wanted label, just post a comment, the maintainers are usually
happy for any support that they can get.
Our pyos-package-template could always use more documentation, whether as
part of the official documentation, in docstrings, an update to our Contributing or Development guide. To contribute, [open an issue](https://github.com//
pyopensci/pyos-package-template/issues) to let us know what you will be working on
so that we can provide you with guidance.
The best way to send feedback is to file an issue at https://github.com/pyopensci/pyos-package-template. If your feedback fits the format of one of the issue templates, please use that. Remember that this is a volunteer-driven project and everybody has limited time.
Ready to contribute? Here's how to set up for local development.
-
Fork the https://github.com/pyopensci/pyos-package-template repository on GitHub.
-
Clone your fork locally
git clone git@github.com:your_name_here/pyos-package-template.git
-
Create a branch for local development using the default branch (typically
main) as a starting point. Usefixorfeatas a prefix for your branch name.git checkout main git checkout -b fix-name-of-your-bugfix
Now you can make your changes locally.
-
When you're done making changes, apply the quality assurance tools and check that your changes pass our test suite. This is all included with tox
hatch run test:run
-
Commit your changes and push your branch to GitHub. Please use semantic commit messages.
git add . git commit -m "fix: summarize your changes" git push -u origin fix-name-of-your-bugfix
-
Open the link displayed in the message when pushing your new branch in order to submit a pull request.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests or test modifications as needed.
- If needed, please add documentation around a change that you make by updating our DEVELOPMENT.md file.
- Your pull request will automatically be checked by the full test suite. It needs to pass all tests before it can be considered for merging.
To work on the template locally, you can call the copier template directly. Note that by default, copier uses the latest tag in your commit history. To ensure it uses the latest commit on your current active branch use:
copier copy -r HEAD /path/to/your/template destination-dir
If you want to test it against the latest tag in your local commit history, you can use:
copier copy /path/to/your/template destination-dir
You can use Hatch to run all of the tests for the template:
hatch run test:run
See our DEVELOPMENT guide for more information on local development.