Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.96 KB

Contributing to Simply Give

Together we can create something amazing. Here are some guidelines to follow along the way.

We Develop with Github

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

All code changes happen through Github Flow with PUll Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow).

  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.
  6. Issue that pull request!

Any contributions will be made under the MIT License

Make sure to look it over and know what it entails. MIT License

Report bugs using Github's issues

Please make sure the bug hasn't been reported and fixed already. Report a bug by opening a new issue; it's that easy!

Bug reports should be clear, detailed, and include code if possible

This is an example of a bug report written by Brian Danielak.

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
  • Notes of things you tried

License

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

Attribution

These guidlines were borrowed from Brian Danielak's guidlines

References

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