Skip to content

Contribution Guide

Thank you for considering contributing to Sikessem’s open-source projects!

We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements.

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Process

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. Create a new branch for your feature.
  3. If you’ve added code that should be tested, add tests.
  4. If you’ve changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Open a pull request detailing your changes.

Guidelines

  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
  • You may need to rebase to avoid merge conflicts.
  • Please remember that we follow SemVer.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Code of Conduct

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

License

By contributing to a Sikessem project, you agree that your contributions will be licensed under the LICENSE file in the root directory of each project’s source tree.