Skip to content

Commit f96e260

Browse files
committed
chore: add CONTRIBUTING
1 parent bd8b4bb commit f96e260

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Pull Requests
2+
3+
If you have a new feature in mind, please discuss the feature in an issue to ensure that your
4+
contributions will be accepted.
5+
6+
1. Fork the repo and create your branch from `main`.
7+
2. If you've added code that should be tested, add tests.
8+
3. If you've changed APIs, update the documentation.
9+
4. Ensure the test suite passes with `nix flake check`.
10+
11+
## Commit Message
12+
13+
Commit message should follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/).
14+
type is one of the following.
15+
16+
| commit type | description |
17+
|-------------|-------------------------------------|
18+
| `feat` | add a new feature |
19+
| `fix` | bug fix |
20+
| `perf` | performance improvement |
21+
| `doc` | documentation |
22+
| `ci` | continuous Integration and delivery |
23+
| `refactor` | refactoring |
24+
| `chore` | catch all |
25+
26+
## License
27+
28+
By contributing to `clc`, you agree that your contributions will be dual-licensed under
29+
the terms of the [`LICENSE-MIT`](./LICENSE-MIT) and [`LICENSE-APACHE`](./LICENSE-APACHE) files in the
30+
root directory of this source tree.

0 commit comments

Comments
 (0)