Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (36 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 3.29 KB

Contributing to Coyote

We welcome contributions to Coyote! Coyote was built in the spirit of other successful open-source projects. Thus, community interaction and contribution is very important to us. There are multiple ways to contribute to Coyote.

Discussions and issues

If you start using Coyote and come across an unexpected bug, please open a GitHub Issue, following the provided template and providing as many details as possible. We will try our best to follow up on issues in a timely manner.

If you found a solution to a problem another user described, please share your knowledge with the Coyote community by providing an answer to the issue.

If you have a more high-level question or general remarks about the future of the project, open a GitHub Discussion.

Code contributions

We welcome contributions to Coyote, both for source code as well as documentation. All code should be added via pull requests (PR), targetting the main branch. When opening a PR, please make sure the following steps are followed:

  1. In the PR description, clearly document all changes made. Coyote includes a PR template, which can be used for this purpose.

  2. If adding new functionality, please ensure it works as expeted and add an example/test on how to use it.

  3. Ensure your code is well-commented and documented, with the necessary changes also reflected in Coyote's documentation.

  4. Be sure to to use the same license for your contributions as the current license of the Coyote component you are contributing to (described below)

Code license: Most of Coyote code is licensed under the terms described in LICENSE, which corresponds to the MIT Licence. An exception to this is the Coyote device driver, which is open-sourced with the GPL v2 license. Any contributions to Coyote will be accepted under the same terms of license.

Code reviews: We will aim to review your contribution in a timely manner and, if additional fixes/modifications are needed, provide feedback to guide you. When accepted, your pull request will be merged to the main branch of the repository.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq