Skip to content

Commit 455abe8

Browse files
committed
doc: update CONTRIBUTING
1 parent 6da13de commit 455abe8

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

CONTRIBUTING.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
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-
111
## Commit Message
122

133
Commit message should follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/).
@@ -23,8 +13,17 @@ type is one of the following.
2313
| `refactor` | refactoring |
2414
| `chore` | catch all |
2515

16+
17+
## Development
18+
19+
In syndicationd, we manage the development environment with [Nix](https://nixos.org/).
20+
By executing `nix develop`, the necessary tools for development can be prepared.
21+
22+
To test code, execute `just check`
23+
24+
2625
## License
2726

28-
By contributing to `clc`, you agree that your contributions will be dual-licensed under
27+
By contributing to `syndicationd`, you agree that your contributions will be dual-licensed under
2928
the terms of the [`LICENSE-MIT`](./LICENSE-MIT) and [`LICENSE-APACHE`](./LICENSE-APACHE) files in the
3029
root directory of this source tree.

0 commit comments

Comments
 (0)