Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

52 lines (40 loc) · 2.82 KB

Contributing to SafeAI

We appreciate your interest in this project! 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 the new model or additional features in model
  • Becoming a maintainer

We follow Git 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 own branch from master.
  2. If you've added code that should be tested, add tests so that it prevents the bugs from future development. To see the example test code for uncertainty model: safeai/tests/test_joint_confident.py
  3. Ensure the test suite passes with command python -m unittest discover, executed at the root of the project directory
  4. Make sure your code lints.(Check README.md - Pylint)
  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!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • 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

  • 4 spaces for indentation rather than tabs
  • You can try running pylint for style unification

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, and this Gist by briandk