diff options
| author | Alistair Francis <alistair.francis@wdc.com> | 2019-01-03 01:44:35 +0300 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2019-01-04 13:28:03 +0300 |
| commit | 45c9e14a2f329950645fa7eb30306913650642d8 (patch) | |
| tree | 406a0bb65e2b61a007138bdd467ff0750ebb91ae /docs/contributing.md | |
| parent | 5cbc24b95a541dba3f2b842b54d76435ba4566a7 (diff) | |
| download | opensbi-45c9e14a2f329950645fa7eb30306913650642d8.tar.xz | |
docs: Add a contributing document
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..46a0ad9 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,13 @@ +Contrubuting to OpenSBI +======================== + +All contributions to OpenSBI should be sent as GitHub Pull Requests (PRs) to the main repo avaliable at: https://github.com/riscv/opensbi + +As well as that all work must follow the following rules: +1. We follow the [Linux coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html). This means that ALL patches must include the Signed-off-by line. +2. Commit subject must have atleast one ":" prefix. Common ones are "lib:", "platform:", "firmware:", "docs:" and "top:". +3. Maintainer should prefer "Rebase and Merge" when using GitHub to merge pull requests. Avoid create extra merge commits. +4. Maintainer should avoid creating branches directly in main riscv/opensbi repo. Instead prefer fork of GitHub riscv/opensbi repo and create branches in your own fork for pull requests. +5. Maintainer cannot merge his own pull requests on GitHub. +6. A pull request must get atleast one review from relevant maintainer. +7. A pull request must spend atleast 24 hours in review so that everyone gets a chance to review. |