Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 3.02 KB
Raw

Contributing to HydroUQ

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

If you are interested in contributing, best way would be to write to us on the SimCenter HydroUQ message board.

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.
  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 you make will be under the BSD-2 Clause License

In short, when you submit code changes, your submissions are understood to be under the same BSD-2 Clause 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, and I think it's not a bad model. Here's another example from Craig Hockenberry.

Great Bug Reports tend to have:

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

I'm again borrowing these from HydroUQ Coding Guidelines

License

By contributing, you agree that your contributions will be licensed under BSD-2 Clause License.

References

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