7. Contributing¶

Contributions are welcome, and they are greatly appreciated and credit will always be given.

You can contribute in many ways:

7.1. Types of Contributions¶

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

Ready to contribute? Here’s how to set up riscv_isac for local development.

Clone your fork locally:

$ git clone  https://gitlab.com/incoresemi/riscv-compliance/riscv_isac.git

Create an issue and WIP merge request that creates a working branch for you

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.
When you’re done making changes, check that your changes pass pytest tests, including testing other Python versions with tox:
```
$ cd tests
$ pytest test_riscv_isac.py -v
```

Commit your changes and push your branch to GitLab:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Before you submit a merge request, check that it meets these guidelines:

The merge request should include tests.
If the merge request adds functionality, the docs should be updated.
The merge request should work for Python 3.6, 3.7 and 3.8, and for PyPy. and make sure that the tests pass for all supported Python versions.

To run a subset of tests:

$ pytest tests.test_riscv_isac

A reminder for the maintainers on how to deploy. Make sure all your changes are committed. Then run:

$ bumpversion --no-tag --config-file setup.cfg patch  # possible: major / minor / patch
$ git push origin name-of-your-branch