Firstly thanks for thinking of contributing - the project is open source and all contributions are very welcome 🙂 💥 👍
How to report a bug or suggest a new feature
Create an issue, describing the bug or new feature in as much detail as you can.
- Create an issue describing the change you are proposing.
- Create a pull request. The project uses the fork and pull model:
- Fork the project
- Make your changes on your fork
- Update the tests or add new tests to cover the new behaviour.
- Write a good commit message(s) for your changes
- Create the pull request for your changes
The easiest way to set up your development environment (unless you have Codespaces, which is even easier) is to use Visual Studio Code's Remote Containers functionality:
- System requirements
- Fork the project
- Open the local project folder in a container
- Everything will then be setup for you. You'll be able to run the tests locally.
If you have access to GitHub Codespaces (which allows full remote development from within your browser or VS Code) then all you need to do is fork the project and open it in Codespaces - easy!
- Go
- Java version 15 or above (for running the tests)
- Gauge
The unit tests are written in Go
Set GAUGE_PROJECT_ROOT as an environment variable with the full path of the project root directory,
e.g. /home/someuser/workspace/gauge-confluence
go test -v ./...