Contributing#

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. If you are interested in contributing, please read all this section before doing anything and in case of doubt, contact the developer!

Types of Contributions#

You can contribute in many ways:

Report Bugs#

Before reporting a bug, Ensure the bug was not already reported by searching on GitHub under Issues.

If you are reporting a bug, please use the “Bug report template” here, and 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. If you want to start working on a bug then please write short message on the issue tracker to prevent duplicate work.

Implement Features#

Look through the Github issues for features or add your own request using the Code feature request template here and assign yourself.

Write Documentation#

BoARIO could always use more documentation, whether as part of the official documentation website, in docstrings, in Jupyter Notebook examples, or even on the web in blog posts, articles, and such.

BoARIO uses Sphinx for the user manual (that you are currently reading).

Submit Feedback#

The best way to send feedback is to file an issue at here

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 :)

Pull Request Guidelines#

To update the documentation, fix bugs or add new features you need to create a Pull Request. A PR is a change you make to your local copy of the code for us to review and potentially integrate into the code base.

To create a Pull Request you need to do these steps:

Create a Github account.
Fork the repository.
Clone your fork locally.
Go to the created BoARIO folder with cd boario.
Create a new branch with git checkout -b <descriptive_branch_name>.
Make your changes to the code or documentation.
Run git add . to add all the changed files to the commit (to see what files will be added you can run git add . --dry-run).
To commit the added files use git commit. (This will open a command line editor to write a commit message. These should have a descriptive 80 line header, followed by an empty line, and then a description of what you did and why. To use your command line text editor of choice use (for example) export GIT_EDITOR=vim before running git commit).
Now you can push your changes to your Github copy of BoARIO by running git push origin <descriptive_branch_name>.
If you now go to the webpage for your Github copy of BoARIO you should see a link in the sidebar called “Create Pull Request”.
Now you need to choose your PR from the menu and click the “Create pull request” button. Be sure to change the pull request target branch to <descriptive_branch_name>!

If you want to create more pull requests, first run git checkout main and then start at step 5. with a new branch name.

Feel free to ask questions about this if you want to contribute to BoARIO :)

Testing Guidelines#

To ensure that you do not introduce bugs into BoARIO, you should test your code thouroughly.

From the base BoARIO folder you call pytest to run all the tests, or choose one specific test:

$ pytest
$ pytest tests/tests.py::test_log_input

If you introduce a new feature you should add a new test to the tests directory. See the folder for examples.