`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!

To start contributing, follow these steps:

Fork the version repository.
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.

Set the version repository as upstream:

  git remote add upstream git@github.com:mszostok/version.git

Fetch all the remote branches for this repository:
```
  git fetch --all
```
Set the main branch to point to upstream:
```
  git branch -u upstream/main main
```

You're all set! 🚀

This project adheres to the Go official and Uber guidelines.

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.