Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (17 loc) · 895 Bytes

How can I contribute?

You can contribute to RISC-V Steel in two ways:

  • Creating a new issue

    Open a new issue whenever you want to report a bug, an issue in the docs or request a change.

  • Making a pull request

    Help improve RISC-V Steel by opening a pull request. All contributions are welcome!

How to make a good pull request?

  • Smaller is better.

    Make many small commits rather than one big one that changes a lot of files. Send one pull request for each improvement, new feature or bug fix.

  • Follow existing coding style and conventions.

    Make sure that your code conforms to the style and formatting of the code base.

  • Include test coverage.

    If possible, add unit tests.

  • Add documentation.

    Document your new functionality.