Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

• Report Bugs
• Fix Bugs
• Implement Features
• Write Documentation
• Submit Feedback

Get Started!¶

Ready to contribute? Here's how to set up gotpm for local development.

1. Fork the gotpm repo on GitHub.
2. Clone your fork locally:

git clone git@github.com:<YOUR_GH_USER>/gotpm.git

1. Create a branch for local development:

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

1. When you're done making changes, check that your changes are formatted correctly and the tests are passing.

# format the code
make format

# run the tests
make test

1. Commit your changes and push your branch to GitHub:
2. Submit a pull request through the GitHub website.