Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

113 lines (77 loc) · 2.6 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/vela-s3-cache.git $HOME/vela-s3-cache
  • Navigate to the repository code:
# Change into the project directory
cd $HOME/vela-s3-cache
  • Point the original code at your fork:
# Add a remote branch pointing to your fork
git remote add fork https://git.target.com/your_fork/vela-s3-cache

Running Locally

  • Navigate to the repository code:
# Change into the project directory
cd $HOME/vela-s3-cache
  • Build the repository code:
# Build the code with `make`
make build
  • Run the repository code:
# Run the code with `make`
make run

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/vela-s3-cache
  • Write your code and tests to implement the changes you desire.

  • Build the repository code:

# execute the `build` target with `make`
make build
  • Run the repository code (ensures your changes perform as you desire):
# execute the `run` target with `make`
make run
  • 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!