Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

40 lines (31 loc) · 1.75 KB

Contributing to Retake

Welcome! We're excited that you're interested in contributing to Retake and want to make the process as smooth as possible.

Before submitting a pull request, please review this document, which outlines what conventions to follow when submitting changes. If you have any questions not covered in this document, please reach out to us via email.

Pull Request Worfklow

All changes to Retake happen through Github Pull Requests. Here is the recommended flow for making a change:

  1. Before working on a change, please check to see if there is already a Github issue open for that change.
  2. If there is not, please open an issue first. This gives the community visibility into what you're working on and allows others to make suggestions and leave comments.
  3. Fork the Retake repo and branch out from the dev branch.
  4. Make your changes. If you've added new functionality, add tests.
  5. Open a pull request towards the dev branch. Ensure that all tests and checks pass. Note that the Retake repository has pull request title linting in place and follows the Conventional Commits spec.
  6. Congratulations! Our team will review your pull request.

Documentation

Retake's public-facing documentation is stored in the docs folder. If you are adding a new feature that requires new documentation, please open a separate pull request containing changes to the documentation only. Once your main pull request is merged, the Retake team will review and eventually merge your documentation changes as well.

Licensing

By contributing to Retake, you agree that your contributions will be licensed under the Elastic License 2.0 license.