Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved code-style and contribution documentation #146

Merged
merged 1 commit into from
Feb 3, 2022
Merged

Improved code-style and contribution documentation #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CODE_STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Formatting
* When modifying existing code that does not conform to this style, prefer
matching the existing style

* Files should have suitable copyright headers.

Implementation
--------------

Expand Down
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,10 @@ Unnecessary code churn should be avoided unless as part of a pull request aimed
at improving code quality, such as fixing repeated code style violations or
renaming a function whose meaning is unclear.
Such pull requests should not also introduce significant new functionality.

It is desirable in a pull request to explain how the code presented
has been verified and how the verification has been made
reproducible. Ideally the pull request is accompanied by some form of
automated verification that is presented in a way that the reviewers
of the pull request can run. It is desirable that the pull request
explains how it relates to the existing RISC-V architectural tests.