Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 2.14 KB
Raw

Contributing to Cancel.ge 🎉

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

We Develop with Github 💻

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

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 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. 📝 If you've changed APIs, update the documentation.
  4. ⚙️ Ensure the test suite passes.
  5. 📏 Make sure your code lints.
  6. 📨 Issue that pull request!

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.

Report bugs 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 📝

This is an official GitHub guide for reporting a bug and we think it's not a bad model. Great Bug Reports tend to have:

  • 🔍 A quick summary and/or background
  • 🧑‍💻 Steps to reproduce (Please 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)

People love thorough bug reports. I'm not even kidding. 🙌