Skip to content

Commit

Permalink
Added notes about copyright headers in code, and a reminder that (#146)
Browse files Browse the repository at this point in the history
pull-requests ideally come with an explanation how the correctness of
the PR was established.
  • Loading branch information
martinberger committed Feb 3, 2022
1 parent 5491f01 commit 1e3906f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CODE_STYLE.md
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
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.

0 comments on commit 1e3906f

Please sign in to comment.