Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 1.7 KB

logo 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:

  1. Fork the codeowners-validator repository.

  2. 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.

  3. Set the codeowners-validator repository as upstream:

    git remote add upstream [email protected]:mszostok/codeowners-validator.git
  4. Fetch all the remote branches for this repository:

    git fetch --all 
  5. Set the main branch to point to upstream:

    git branch -u upstream/main main

You're all set! 🚀 Read the development document for further instructions.