Skip to content
This repository has been archived by the owner on Apr 20, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (23 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

45 lines (23 loc) · 1.85 KB

Contributing

Contributions are always welcome here ❤️

Check our GitHub issues page if you're looking for somewhere to start! :octocat:

There is always room for improvement, why not work to improve documentation and testing if you're stumped? 📚

Guidelines

Once you've found something you want to work on, make your changes and create a Pull Request! ✔️

Formatting

Remember to format Go code using gofmt, I recommend setting up VS Code to do it for you. 🤖

Comments and Documentation

Follow Effective Go standards and you'll be a star! ⭐

All modified code should include proper comments, even if they were missing before. 📓

This improves docs for the entire module, making it even easier for new contributors to get started! 🌱

Breaking changes should be noted in the PR with a reason. Note: These may not be merged for some time. ☠️

Testing and Benchmarking

Tests should be included wherever possible, benchmarks are welcome too. 🧪

We do welcome PRs without tests, but PRs with tests are preferred. 🔬

Commits

Commit messages should convey a clear and concise summary of changes along with a reason for the change. 💬

Please try to keep commit messages to 50 characters as this helps when viewing commits in various tools. 👀

If you cannot meet these requirements, consider separating your changes into multiple commits. 🔱

Please avoid adding WIP commits to PRs, squash them before opening the PR. ☢️

Questions

Please avoid opening issues to ask questions, instead head over to the new discussions tab! 📝