CONTRIBUTING.md

Contributing to the Secretless Broker

Thanks for your interest in the Secretless Broker. Before contributing, please take a moment to read and sign our Contributor Agreement. This provides patent protection for all Secretless Broker users and allows CyberArk to enforce its license terms. Please email a signed copy to oss@cyberark.com.

Pull Request Workflow

1. Search the open issues in GitHub to find out what has been planned
2. Select an existing issue or open an issue to propose changes or fixes
3. Move the issue to "in progress" in Waffle as you work on it
4. Run tests as described here, ensuring they pass
5. Submit a pull request, linking the issue in the description
6. Move the issue to "in review" in Waffle, ask another contributor to review and merge your code

Our Waffle.io is synchronized with GitHub and helps you navigate this workflow more easily.

Style guide

Use this guide to maintain consistent style across the Secretless Broker project.