Skip to content

Commit da609f6

Browse files
committed
Add some more detail on contributing
1 parent bc60641 commit da609f6

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

CONTRIBUTING.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,33 @@ We welcome all contributions that fall within our xref:CODE_OF_CONDUCT.adoc[code
77

88
=== Bug Reports
99

10-
Bug reports should be filed as a GitHub Issue using the Bug report template.
10+
Bug reports should be filed as a https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] using the `Bug report` template.
1111

1212
=== Feature Requests
1313

14-
Bug reports should be filed as a GitHub Issue using the Feature request template.
14+
Bug reports should be filed as a https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] using the `Feature request` template.
1515

1616
=== Bug Fixes
1717

1818
Bug fixes should be submitted as a Pull Request.
1919

20+
There should be a corresponding https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] for the PR. Ensure the two are linked by adding "closes #<issue number>" in the PR description.
21+
2022
=== New data, tools, and features
2123

2224
New data (for example, adding an extension), tools, or features should be submitted as a Pull Request.
2325

24-
== Submitting a patch
26+
There should be a corresponding https://github.com/riscv-software-src/riscv-unified-db/issues[GitHub Issue] for the PR. Ensure the two are linked by adding "closes #<issue number>" in the PR description.
27+
28+
== Submitting a Pull Request
2529

2630
All patches must meet the UnifiedDB code standards. This includes:
2731

2832
* Pass regression tests (run locally as `./do test:regress`)
2933
* Go through code review as a Pull Request
3034
** Code owners must approve
3135
* Use appropriate commit messages (TODO: commit message policy)
36+
37+
== Finding tasks
38+
39+
If you are looking to contribute but are unsure what to do, browse through the https://github.com/riscv-software-src/riscv-unified-db/issues[issues]. We try to keep them tagged by area and mark easier tasks with "good first issue".

0 commit comments

Comments
 (0)