Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 2.08 KB

Contributing

Getting Started

We'd love to accept your contributions to this project! If you are a first time contributor, please review our Contributing Guidelines before proceeding.

Prerequisites

Setup

  • Fork this repository

  • Clone this repository to your workstation:

# clone the project
git clone [email protected]:go-vela/server.git $HOME/go-vela/server
  • Navigate to the repository code:
# change into the cloned project directory
cd $HOME/go-vela/server
  • Point the original code at your fork:
# add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/server

Development

Please review the local development documentation for more information.

  • Navigate to the repository code:
# change into the cloned project directory
cd $HOME/go-vela/server
  • Write your code and tests to implement the changes you desire.

  • Run the repository code (ensures your changes perform as you desire):

# execute the `up` target with `make`
make up
  • Test the repository code (ensures your changes don't break existing functionality):
# execute the `test` target with `make`
make test
  • Clean the repository code (ensures your code meets the project standards):
# execute the `clean` target 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!