Skip to content

Commit 1e3906f

Browse files
authored
Added notes about copyright headers in code, and a reminder that (riscv#146)
pull-requests ideally come with an explanation how the correctness of the PR was established.
1 parent 5491f01 commit 1e3906f

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CODE_STYLE.md

+2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Formatting
4848
* When modifying existing code that does not conform to this style, prefer
4949
matching the existing style
5050

51+
* Files should have suitable copyright headers.
52+
5153
Implementation
5254
--------------
5355

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,10 @@ Unnecessary code churn should be avoided unless as part of a pull request aimed
2020
at improving code quality, such as fixing repeated code style violations or
2121
renaming a function whose meaning is unclear.
2222
Such pull requests should not also introduce significant new functionality.
23+
24+
It is desirable in a pull request to explain how the code presented
25+
has been verified and how the verification has been made
26+
reproducible. Ideally the pull request is accompanied by some form of
27+
automated verification that is presented in a way that the reviewers
28+
of the pull request can run. It is desirable that the pull request
29+
explains how it relates to the existing RISC-V architectural tests.

0 commit comments

Comments
 (0)