Contributing to Gauge
Contributions to Gauge are welcome and appreciated. Coding is definitely not the only way you can contribute to Gauge. There are many valuable ways to contribute to the product and to help the growing Gauge community.
Please read this document to understand the process for contributing.
Different ways to contribute
- You can report an issue you found
- Help us test Gauge by adding to our existing automated tests
- Help someone get started with Gauge on our discussion forum
- Contribute to our blog
- Add to our set of examples to help someone new to Gauge get started easily
- Help us improve our documentation
- Contribute code to Gauge!
All repositories are hosted on GitHub. Gauge’s core is written in Golang but plugins are, and can be, written in any popular language. Pick up any pending feature or bug, big or small, then send us a pull request. Even fixing broken links is a big, big help!
How do I start contributing
There are issues of varying levels across all Gauge repositories. All issues that need to be addressed are tagged as 'Help Needed'. One easy way to get started is to pick a small bug to fix. These have been tagged as 'Easy Picks'.
Gauge Core v/s Plugins
Gauge Core is a project that has features that would reflect across all Gauge use cases. These features are typically agnostic of the user's choice of implementation language.
Plugins are meant to do something specific. These could be adding support for a new language, or have a new report etc. So, depending on where you see your contribution fit, please focus on the respective repository.
If your contribution is a code contribution and you do send us a pull request, you will first need to read and sign the Contributor License Agreement.
If you are trying to write plugins for Gauge or trying to contribute to Gauge core, take a look at the Developer Documentation.