Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.74 KB
Raw

Contributing to Unlist

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

We develop with Github

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

All changes happen through branching and pull requests

Unless permissions are granted by founding members

  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. 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!

Bug Reports

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
  • Possibly including why you think this might be happening, or stuff you tried that didn't work

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