Skip to content

Guidelines#

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Predator and its packages, which are hosted in the Zooz Predator project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Submitting a Bug Report#

Bugs are tracked as GitHub issues. Provide the following information when submitting a bug:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Contributing Code Changes#

As an open-source project, we welcome and encourage the community to submit patches directly to the project. In our collaborative open source environment, standards for submitting changes help reduce the chaos that can result from an active development community. So here are some high-level steps we suggest you follow when contributing code changes:

  1. Fork the project & clone locally.
  2. Create an upstream remote and sync your local copy before you branch.
  3. Branch for each separate piece of work.
  4. Do the work, write good commit messages. Commit messages must adhere to commitlint standards.
  5. Push to your origin repository.
  6. Create a new PR in GitHub.
  7. Respond to any code review feedback.

Contributing Documentation Changes#

Documentation is mega-important. Predator cannot truly succeed without great documentation. It’s that simple. So please make sure to provide documentation updates for any new features you contributed, including useful example code snippets.

Needless to say, as a user of this project you're perfect for helping us improve our docs. So feel free to report documentation bugs or submit documentation changes through a pull request.