Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (36 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 1.66 KB

Contributing

Thanks for your interest in contributing!

License and Contributions

This project is licensed under the Elastic License 2.0 (ELv2).

By submitting a contribution, you agree to the terms of our Contributor License Agreement (CLA). When you open your first pull request, a bot will ask you to review and sign the Springtail Individual CLA. You only need to sign it once; subsequent pull requests from the same GitHub account are covered automatically.

How to Contribute

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Development and Testing

Before making non-trivial changes, please read through our developer documentation on the project wiki:

  • Development — prerequisites, environment setup, building from source, and the general workflow for hacking on Springtail.
  • Testing — how the test suites are organized, how to run them locally, and what we expect new changes to cover.

If you find any of this documentation out of date or unclear, fixes to the wiki are themselves welcome contributions.

Guidelines

  • Keep changes focused and minimal
  • Add tests where appropriate
  • Update documentation if needed

Pull Request Process

  • Ensure your PR passes all checks
  • Sign the CLA when prompted
  • Address review feedback

Code of Conduct

This project adopts the Contributor Covenant as its Code of Conduct. All contributors are expected to follow it; please read CODE_OF_CONDUCT.md before participating.