Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 3.5 KB
Raw

Contributing to FiberCrypto projects

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

We Develop with Github

We 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 use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
    • Branch name should follow the pattern <USER>_t<ISSUE>_<DESC> e.g. olemis_t256_readme_badges for @olemis to submit a patch to fix issue #256 by adding project badges in README.md file.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. If contributions add a relevant feature, describe changes in CHANGELOG.md
  5. Check Travis build results.
  6. Ensure the test suite passes on Travis.
  7. Make sure your code lints on Travis.
  8. Issue that pull request!

Any contributions you make will be under the GPLv3 Software License

In short, when you submit code changes, your submissions are understood to be under the same GPLv3 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 that we think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom we greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. This stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what reporter was seeing
  • 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.

Use a Consistent Coding Style

Code style shall respect golang standards and is checked by a number of linters after running make lint from the command line.

License

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

References

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