CONTRIBUTING.md

Contributing

Contributors are encouraged to be a member of the OpenHW Group. New members are always welcome. Have a look at README.

The Mechanics

1. Fork the force-riscv repository.
   

2. Clone repository:
   git clone https://github.com/[your_github_username]/force-riscv
   

3. Create your feature branch:
   git checkout -b <my_new_branch>
   Please uniquify your branch name. See the Git Cheats for a useful nominclature.
   

4. Test your changes.

5. Add your changes to git.
   git add *

6. Commit your changes:
   git commit -sm 'Add some feature'
   ...note that -s (signoff) is now optional.

7. Push feature branch:
   git push origin <my_new_branch>
   

8. Submit a pull request.

PyCodeStyle

We have recently joined many other fine software projects by adopting Black as our python code format standard. In order to set your git pre-commit hook to check your changes automatically, please install pre-commit using either pip:
pip install pre-commit

or, using the non-admin approach of:
curl https://pre-commit.com/install-local.py | python3 -

Then, from our project root folder, run:
pre-commit install

For complete details, visit:
pre-commit.com