Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.81 KB
Raw

Contributing to tosu

I love your input! I 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

Develop with Github

Use github to host code, to 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 master.
  2. Make sure your code lints. (pnpm run prettier:fix)
  3. Issue that pull request!

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

In short, when you submit code changes, your submissions are understood to be under the same GNU Lesser General Public License v3.0 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

Great Bug Reports tend to have:

  • A quick summary and/or 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)

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

References

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