Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

54 lines (39 loc) · 2.63 KB
Raw

Contributing to Modmail

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

If you are proposing new features, please discuss them with us in the development server before you start working on them!

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

We Use Git Flow

Simple Image Of A Git Flow Workflow
When contributing to this project, please make sure you follow this and name your branches appropriately!

All Code Changes Happen Through Pull Requests

Make sure you know how Git Flow works before contributing! Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master or development according to Git Flow.
  2. Update the CHANGELOG.
  3. If you've changed core/* or bot.py, mark changelog as "BREAKING" since plugins may break.
  4. Make sure your code passes the lint checks.
  5. Create Issues and pull requests!

Any contributions you make will be under the GNU Affero General Public License v3.0

In short, when you submit code changes, your submissions are understood to be under the same GNU Affero General Public License v3.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github 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 background
  • Steps to reproduce
    • Be specific!
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

We use black for a unified code style.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft