Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 3.01 KB
Raw

Contributing to FitnessMachine

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

License

This project is licensed under the PolyForm Strict. The text of the license supercedes this message, but the gist of it is that you are free to use this project for personal or academic use.

If you would like to discuss obtaining another license, get in touch.

We Develop with Github

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

Suggesting a Change

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Raise an issue describing the change you're about to make and the reasoning behind it.
  2. Fork the repo and create your branch from master.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Issue that pull request!

Any Contributions You Make Will Be Under the Repository's Licence

In short, when you submit code changes, your submissions are understood to be under the same license that covers the project.

You are also granting the maintainers personal and irrevocable licenses to use, modify, sell, and redistribute your contributions in addition to the rights granted by the project license.

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

Bugs are a lot easier to bash if bug reports have sufficient information in them from the start:

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
    • Provide any output that demonstrates unexpected/buggy results.
    • Bonus points if you can provide an MRE. Although we understand not everyone can do this.
  • 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

Please just follow standard C# coding style. Your IDE should hopefully infer the style rules from the source code.

References

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