We'd love to accept your contributions to this project! There are just a few guidelines you need to follow.
Bug reports should be opened up as issues on the go-vela/community repository!
Feature Requests should be opened up as issues on the go-vela/community repository!
NOTE: We recommend you start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on.
We are always open to new PRs! You can follow the below guide for learning how you can contribute to the project!
- Review the commit guide we follow - ensure your commits follow our standards
- Golang - for source code and dependency management
-
Fork this repository
-
Clone this repository to your workstation:
# Clone the project
git clone [email protected]:go-vela/cli.git $HOME/go-vela/cli- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/cli- Point the original code at your fork:
# Add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/cli- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/cli- Build the repository code:
# Build the code with `go`
CGO_ENABLED=0 go build -o ./vela-cli github.com/go-vela/cli- Run the repository code:
# Run the code
./vela-cli- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/cli-
Write your code and test locally
- Please be sure to follow our commit rules
-
Write tests for your changes and ensure they pass:
# Test the code with `go`
go test ./...- Ensure your code meets the project standards:
# Clean the code with `go`
go mod tidy
go fmt ./...
go vet ./...- Push to your fork:
# Push your code up to your fork
git push fork master- Open a pull request. Thank you for your contribution!