You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTION.md
+28-2Lines changed: 28 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,33 @@ Your inputs are welcome and greatly appreciated! We want to make contributing to
9
9
- Becoming a maintainer
10
10
11
11
## We develop with Github
12
+
12
13
We use github to host code, to track issues and feature requests, as well as accept pull requests.
13
14
15
+
## Prepare
16
+
17
+
We use [ruff](https://docs.astral.sh/ruff/) as our linter and formatter, all the changes you made will be checked by out CI pipeline. So you should:
18
+
19
+
- install ruff: `pip install ruff` or [more install methods](https://docs.astral.sh/ruff/installation/)
20
+
21
+
To run CI locally, you can use [pre-commit](https://pre-commit.com/), it runs the same check as CI pipeline:
22
+
23
+
- install pre-commit: `pip install pre-commit`
24
+
25
+
then you can run check directly by: `pre-commit run`
26
+
27
+
> notice that pre-commit will only run on the staged files, if you want to check all, please use `pre-commit run -a`
28
+
29
+
If you use git, you can set [git hooks](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks) automatically by:
30
+
31
+
- set git hooks: `pre-commit install`
32
+
33
+
then pre-commit check will be triggered automatically when you run `git commit`
34
+
35
+
> if your think some changes are necessary even though they won't pass the check, you can use `git commit --no-verify` which will skip the pre-commit check.
36
+
37
+
If you are using vscode, you can also use [Offical Ruff Extension for vscode](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) to automatically format/lint your code on save.
38
+
14
39
## We use a simple git flow where all code changes happen through Pull Requests
15
40
16
41
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
@@ -54,9 +79,11 @@ Note: You can have either a patch or minor or major update.
54
79
Note: In case of a conflict, the maintainers will decide the final version to be assigned.
55
80
56
81
## Any contributions you make will be under the permissive open-source License
82
+
57
83
In short, when you submit code changes, your submissions are understood to be under a permissive open source license like BSD-3, Apache-2.0 and CC, etc that covers the project. Feel free to contact the maintainers if that's a concern.
58
84
59
85
## Report bugs using Github's [issues](https://github.com/riscv/riscv-arch-test/issues)
86
+
60
87
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/riscv/riscv-arch-test/issues/new); it's that easy!
61
88
62
89
## Write bug reports with detail, background, and sample code
@@ -66,12 +93,11 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
66
93
- A quick summary and/or background
67
94
- Steps to reproduce
68
95
- Be specific!
69
-
- Give sample code if you can.
96
+
- Give sample code if you can.
70
97
- What you expected would happen
71
98
- What actually happens
72
99
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
73
100
74
101
## License
75
102
By contributing, you agree that your contributions will be licensed under its permissive open source
0 commit comments