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 [email protected]:go-vela/vela-openssh.git $HOME/go-vela/vela-openssh- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-openssh- 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-openssh- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-openssh- Build the repository code:
# Build the code with `make`
make build- Run the repository code:
# Run the code with `make`
make run- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/vela-openssh-
Write your code and tests to implement the changes you desire.
-
Test the repository code (ensures your changes don't break existing functionality):
# execute the `test` target with `make`
make test- Ensure your code meets the project standards:
# Clean the code with `make`
make clean- 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!