21 lines
1.1 KiB
Markdown
21 lines
1.1 KiB
Markdown
# Contributing to Sawa Server
|
|
|
|
Thanks for contributing to Sawa Server (SS)!
|
|
|
|
## Commit Conventions
|
|
We follow the same commit conventions as the `sawa-control-panel` project. Please ensure your commits adhere to these rules:
|
|
|
|
- **feat:** A new feature (e.g., `feat: add ss-init script for first boot`)
|
|
- **fix:** A bug fix (e.g., `fix: resolve issue with lbu commit on unmounted drive`)
|
|
- **docs:** Documentation only changes
|
|
- **style:** Changes that do not affect the meaning of the code (formatting, missing spaces, etc.)
|
|
- **refactor:** A code change that neither fixes a bug nor adds a feature
|
|
- **perf:** A code change that improves performance
|
|
- **test:** Adding missing tests or correcting existing tests
|
|
- **chore:** Changes to the build process or auxiliary tools and scripts
|
|
|
|
Please write your commit messages in the imperative mood (e.g., "Add feature" instead of "Added feature").
|
|
|
|
## General Guidelines
|
|
- Keep scripts POSIX-compliant or standard `ash` compatible, given our Alpine Linux environment.
|
|
- Test changes on actual bootable media or a compatible VM before submitting.
|