Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

75 lines (46 loc) · 3.29 KB

Contributing to mgod

🚀 Embrace the Power of Your Ideas!

Contributing to this project is a breeze—we thrive on your input. Be it bug fixes, feature requests, or just sharing your thoughts, we're committed to making your journey seamless and transparent. Join us in shaping excellence together!

Curious or Stuck?

Whether you're troubleshooting a problem or seeking advice, our discussion channel provides a supportive space for engaging conversations and valuable solutions.

Connect with us to tap into a wealth of knowledge and make the most of your experience!

Feature Requests Accepted

You can request a new feature by submitting an issue to our GitHub Repository.

  • Propose Major Features by opening an issue to streamline coordination, prevent duplication, and ensure successful project integration.
  • Small Features can be crafted and directly submitted as a Pull Request.

Report Bugs or Raise Issues using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think mthis might be happening, or stuff you tried that didn't work)

We use Github Flow, so all code changes happen through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints and follow the coding style
  5. Send a pull request to mgod:main. Make sure to allow edits from maintainers.

Use a Consistent Coding Style

Embrace Coding Practices outlined in Effective Go and adopt the Best Coding Style Practices as detailed in the Go Style Guide

  • Use 2 spaces for indentation rather than tabs

License

Any contributions you make will be under the MIT Software License. In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.