47 lines
1.5 KiB
Markdown
47 lines
1.5 KiB
Markdown
# Contributors Guide
|
|
|
|
This document describes the contribution process and formatting standards for
|
|
this project. All contributors are expected to follow these guidelines to ensure
|
|
a consistent and maintainable codebase.
|
|
|
|
## Contribution Workflow
|
|
|
|
- Work must be done in a dedicated branch (e.g., `feature/xyz`, `fix/abc`).
|
|
- Code must follow the established structure under `src/`.
|
|
- All contributions must be made through pull requests to the `main` branch.
|
|
- Contributions must include meaningful commit messages that follow the defined\
|
|
format.
|
|
|
|
## Commit Message Format
|
|
This project uses [Gitmoji](https://gitmoji.dev/). Each commit message must
|
|
begin with a Gitmoji and follow the defined structure.
|
|
|
|
### Format
|
|
```
|
|
:emoji: Subject line
|
|
|
|
[Optional body message]
|
|
```
|
|
|
|
- The subject line must be written in the **imperative mood**, **capitalized**,\
|
|
and **limited to 80 characters maximum**.
|
|
- The optional body should be wrapped at **80 characters per line**.
|
|
- The subject must not end with a period.
|
|
|
|
### Example
|
|
```
|
|
:memo: Update README with usage examples
|
|
```
|
|
## Contribution Steps
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch: `git checkout -b feature/my-feature`.
|
|
3. Write code and commit using the specified format.
|
|
4. Push to the forked repository: `git push origin feature/my-feature`.
|
|
5. Open a pull request with a clear, descriptive title.
|
|
|
|
## Licensing
|
|
|
|
By contributing to this project, all contributors agree that their code will be
|
|
licensed under the same license as the project.
|