Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.16 KB

File metadata and controls

32 lines (23 loc) · 1.16 KB

Contributing

Thanks for your interest in contributing! This project is part of the keiailab open-source suite, with a public mirror on GitHub.

Where to send changes

The canonical repository is on GitLab: https://keiailab.synology.me/gitlab/keiailab/oss/<project>. The GitHub repository is a read-only push mirror — please open Merge Requests on GitLab. (Issues are welcome on either platform.)

Development workflow

  1. Create a feature branch: git checkout -b feat/<topic>.
  2. Make your change, with tests for any behavioral difference.
  3. Make sure lint and tests pass locally.
  4. Open a Merge Request against main.

Guidelines

  • Follow the existing code style of the project.
  • Use Conventional Commits for commit messages (feat:, fix:, docs:, chore: …).
  • Keep changes focused and atomic — one logical change per Merge Request.
  • Write or update tests; a behavioral change without a test is incomplete.

License

By contributing, you agree that your contributions are licensed under the project's MIT License.