Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/Horizon-Builder/Horizon-Builder/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.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Horizon Builder could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/Horizon-Builder/Horizon-Builder/issues.
If you are proposing a new 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 :)
Ready to contribute? Here's how to set up Horizon Builder
for local development.
Please note this documentation assumes you already have pdm
and Git
installed and ready to go.
-
Fork the
Horizon Builder
repo on GitHub. -
Clone your fork locally:
cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/Horizon-Builder.git
- Now we need to install the environment. Navigate into the directory
cd Horizon-Builder
If you are using pyenv
, select a version to use locally. (See installed versions with pyenv versions
)
pyenv local <x.y.z>
Using PDM, install and activate the environment with:
pdm update
sh -c $(pdm venv activate)
- Install pre-commit to run linters/formatters at commit time:
pre-commit install
- Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
-
Don't forget to add test cases for your added functionality to the
tests
directory. -
When you're done making changes, check that your changes pass the unit tests.
make test
- Make sure that the changes provide a working binary.
make build
This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.
- 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
- Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
-
The pull request should include tests.
-
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.md
.