Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.77 KB
Raw

Contributing to YellowSpyglass

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

Develop with Github

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

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 master.
  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 (yarn lint)
  6. Make sure your code is prettier'd (yarn prettier)
  7. 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 example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

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)

Any bug reported is appreciated. I'm currently the only person working on this project, so things might be slow, but there's no harm in logging as many bugs as there are issues. I will review each and every one.

Use a Consistent Coding Style

I use prettier & eslint to enforce a consistent coding style for this project.

Make sure to run yarn prettier & yarn lint before submitting a PR.

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