Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

59 lines (45 loc) · 2.48 KB
Raw

Contributing

Thank you for your interest in contributing to awi-cli! Please make sure you read the full code of conduct before making any contribution.

Before contributing to this repository, please first create an issue discussing the change you wish to make or discuss about it via email with one of the owners of the project.

We kindly ask you to follow the following code of conduct in all your interactions with the project.

Forking the project

Before doing any work, please make sure you are working on a local fork of the project. For more information and instructions on how to do so, please refer to GitHub's contributing guide.

Reporting Issues

Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our issues list.

When creating a new issue, please be sure to include a title and clear description, as much relevant information as possible, and, if possible, a test case.

If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in SECURITY.md.

Pull Request Process

  1. Ensure any install or build dependencies are removed before asking to merge your code.
  2. Update the README.md with details of changes to the interface, including new environment variables, exposed ports, file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer. Alternatively
  4. You may ask one (or more) of the code owners to review and merge your Pull Request.

Other Ways to Contribute

We welcome anyone that wants to contribute to awi-cli to triage and reply to open issues to help troubleshoot and fix existing bugs. Here is what you can do:

  • Help ensure that existing issues follows the recommendations from the Reporting Issues section, providing feedback to the issue's author on what might be missing.
  • Review and update the existing content of our documentation with up-to-date instructions and code samples.
  • Review existing pull requests, and testing patches against real existing applications that use awi-cli.
  • Write a test, or add a missing test case to an existing test.