Fork using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
Fork using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
Fork with GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
Make your changes to the file(s) you'd like to update.
Test your changes by running all tests with python -m unittest discover.
When you're done making changes and you'd like to propose them for review, use the pull request template to open your PR (pull request).
- Once you submit your PR, others from the pybsn community will review it with you.
- Automatic tests and code analysis will be run against your contribution. Make sure your code passes these checks.
- After that, we may have questions, check back on your PR to keep up with the conversation.
Congratulations! The pybsn community thanks you. ✨
To help release a new version of pybsn, there are two github actions. They are triggered when a new tag is pushed to the repository. Each tag push is considered a release, and each of the two actions will attempt to create a release using the version found in setup.py. The name of the tag does not matter from a technical perspective, but should match the version in the setup.py file.
- release-github.yml
Creates a release on github. The release description is the message of the last commit of the release branch (
main). - release-pypi.yml Creates a release on PyPi.
This CONTRIBUTING.md has been adapted from Github Docs.