Skip to content

Commit 84f2c9c

Browse files
committed
docs: separate contributing guideline
1 parent ae9bb44 commit 84f2c9c

File tree

2 files changed

+33
-37
lines changed

2 files changed

+33
-37
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Contributing
2+
3+
Thank you for your interest in contributing!
4+
5+
### Setup
6+
7+
1. Fork the repository.
8+
2. Clone your fork and create a feature branch:
9+
```sh
10+
git checkout -b feat/your-feature
11+
```
12+
13+
3. Build and test:
14+
15+
```sh
16+
mvn clean verify
17+
```
18+
19+
### Commit Guidelines
20+
21+
Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Examples:
22+
23+
* `feat(core): add support for X`
24+
* `fix(template): correct behavior of Y`
25+
* `docs: README commit guideline`
26+
27+
### Pull Requests
28+
29+
* Target the `main` branch.
30+
* Ensure all tests pass.
31+
* Include relevant tests and documentation.
32+
33+
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.

README.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -393,40 +393,3 @@ When uploading files via a custom script, ensure the files are not altered in an
393393
```python
394394
open(filename, encoding="utf-8", newline="")
395395
```
396-
397-
---
398-
399-
## Contributing
400-
401-
Thank you for your interest in contributing!
402-
403-
### Setup
404-
405-
1. Fork the repository.
406-
2. Clone your fork and create a feature branch:
407-
```sh
408-
git checkout -b feat/your-feature
409-
```
410-
411-
3. Build and test:
412-
413-
```sh
414-
mvn clean verify
415-
```
416-
417-
### Commit Guidelines
418-
419-
Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Examples:
420-
421-
* `feat(core): add support for X`
422-
* `fix(template): correct behavior of Y`
423-
* `docs: README commit guideline`
424-
425-
### Pull Requests
426-
427-
* Target the `main` branch.
428-
* Ensure all tests pass.
429-
* Include relevant tests and documentation.
430-
431-
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.
432-

0 commit comments

Comments
 (0)