CONTRIBUTING.md
August 31, 2021 ยท View on GitHub
Codeowners Validator - contributing
๐๐๐ค Thanks for your interest in the Codeowners Validator project! ๐ค๐๐
This document contains contribution guidelines for this repository. Read it before you start contributing.
Contributing
Before proposing or adding changes, check the existing issues and make sure the discussion/work has not already been started to avoid duplication.
If you'd like to see a new feature implemented, use this feature request template to create an issue.
Similarly, if you spot a bug, use this bug report template to let us know!
Ready for action? Start developing!
To start contributing, follow these steps:
-
Fork the
codeowners-validatorrepository. -
Clone the repository locally.
TIP: This project uses Go modules, so you can check it out locally wherever you want. It doesn't need to be checked out in
$GOPATH. -
Set the
codeowners-validatorrepository as upstream:git remote add upstream git@github.com:mszostok/codeowners-validator.git -
Fetch all the remote branches for this repository:
git fetch --all -
Set the
mainbranch to point to upstream:git branch -u upstream/main main
You're all set! ๐ Read the development document for further instructions.