CONTRIBUTING.md

version - contributing

Thanks for your interest in the version 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 me know!

Ready for action? Start developing!

To start contributing, follow these steps:

1. Fork the version repository.

2. Clone the repository locally.

   Note 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 version repository as upstream:

     git remote add upstream [email protected]:mszostok/version.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! 🚀

Go style guidelines

This project adheres to the Go official and Uber guidelines.

Documentation

• pip

• Magefile

  Note Run mage -l to see all possible targets.

Build the site locally

• Install mkdocs and the mkdocs-material theme

  pip install -r requirements.txt

• Start local server

  mkdocs serve -D

  Site can be viewed at http://localhost:8000

• Find the documentation page file (.md file) under docs/ and edit it.