Skip to content

How to Contribute

We're grateful for your interest in contributing to our emulators! Please follow our guidelines to ensure a smooth contribution process.

Reporting an Issue or Proposing a Feature

Your course of action will depend on your objective, but generally, you should start by creating an issue. If you've discovered a bug or have a feature you'd like to see added, feel free to create an issue on the issue tracker. Here are some steps to take:

  1. Quickly search the existing issues using relevant keywords to ensure your issue hasn't been addressed already.

  2. If your issue is not listed, create a new one. Try to be as detailed and clear as possible in your description.

  3. If you're merely suggesting an improvement or reporting a bug, that's already excellent! We thank you for it. Your issue will be listed and, hopefully, addressed at some point.

  4. However, if you're willing to be the one solving the issue, that would be even better! In such instances, you would proceed by preparing a Pull Request.

Submitting a Pull Request

We're excited that you're eager to contribute to our emulators! To contribute, create a branch on the emulators repository and once you are satisfied with your feature and all the tests pass create a Pull Request.

Here's the process for making a contribution:

Make a new branch via

git branch <your initials>/<branch name>

Next, checkout your new branch, and associate a branch to it on the GitHub server:

git checkout <your initials>/<branch name>
git push --set-upstream origin <your initials>/<branch name>

Setting up your development environment

Our repo is currently not compatible with hatch. The repo installs properly using pip directly.

pip install -e .

We recommend using a virtual environment. To run the automated tests, assuming you installed the repo using the above, use:

pip install -r test_requirements.txt

pytest

Useful Things for your workflow: Linting and Testing

Use pre-commit hooks to make sure that the code is properly linted before pushing a new commit. Make sure that the unit tests and type checks are passing since the merge request will not be accepted if the automatic CI/CD pipeline do not pass.

pip install pre-commit
pre-commit install
pre-commit run --all-files
pytest

Make sure your docs build too! First, pip install the dependencies: 

pip install -r doc_requirements.txt

Then build the documentation:

 mkdocs build --clean --strict