CONTRIBUTING.md

Contributing to Poteto

I appreciate your consideration to contribute to this project! This document is a guide to help make your contribution easier and more effective. Thank you :)

Getting Started

Prerequisites

• Docker or go1.21.8

Build

• You can use devcontainer
• Test

./run_test.sh

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub.

1. Check the Issue Tracker for existing issues.
2. When requesting a new issue or feature, please use the templates and provide as much detail as possible.

Development

1. Check the Issue Tracker, make sure if there is anything relevant to the problem you are trying to solve. Or create New Issue.
2. Fork repo
3. Create a new branch.

git checkout -b your-account/feature

4. Make changes to the code and run tests to make sure everything is working properly.
5. Write a clear commit message.
6. Pull request

Thank you :)