We'd love to accept your contributions to this project! If you are a first time contributor, please review our Contributing Guidelines before proceeding.
- Review the commit guide we follow - ensure your commits follow our standards
- Review our style guide to ensure your code is clean and consistent.
- Docker - building block for local development
- Docker Compose - start up local development
- Make - start up local development
-
Fork this repository
-
Clone this repository to your workstation:
# Clone the project
git clone git@github.com:go-vela/vela-k6.git $HOME/go-vela/vela-k6- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-k6- Point the original code at your fork:
# Add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/vela-k6- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-k6- Build the repository code:
# Build the code with `make`
make build- Run the repository code:
# Run the executable
./vela-k6- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-k6-
Write your code and tests to implement the changes you desire.
-
Run the repository code (ensures your changes perform as you desire):
- Ensure the appropriate environment variables are set (
PARAMETER_SCRIPT_PATH, optionallyPARAMETER_OUTPUT_PATH,PARAMETER_PROJEKTOR_COMPAT_MODE, andPARAMETER_FAIL_ON_THRESHOLD_BREACH)
- Ensure the appropriate environment variables are set (
# execute the `start` target with `make`
make start- Test the repository code (ensures your changes don't break existing functionality):
# execute the `test` target with `make`
make test- Check the repository code (ensures your code meets the project standards):
# execute the `check` target with `make`
make check- Push to your fork:
# push your code up to your fork
git push fork main- Make sure to follow our PR process when opening a pull request
Thank you for your contribution!