Skip to main content

Contribute guide

Did you find a bug?​

  • Do not open up a GitHub issue if the bug is a security vulnerability in Starsky, and instead to refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • For more detailed information on submitting a bug report and creating an issue, please use the templates

Did you write a patch that fixes a bug?​

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Make sure that the Pull Request template is followed

  • Use Github Issues to discuss choices and try to keep the pull request as small as possible. Small PRs are easier to check.

Did you fix whitespace, format code, or make a purely cosmetic patch?​

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Starsky will generally not be accepted

Do you intend to add a new feature or change an existing one?​

Do you have questions about the source code?​

  • We currently don't have a special place for this, you can contact me.

Do you want to contribute to the Starsky documentation?​

  • Currently there are markdown files in the project Check the documentation site for more info

Starsky is a volunteer effort. We encourage you to pitch in and join the team!

Thanks! ❤️ ❤️ ❤️

Starsky Team