Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.79 KB
Raw

Contributing to Blazor Boilerplate

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

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Please first discuss the change you wish to make via issue or Blazor Boilerplate Gitter with the owners of this repository before making a change.
  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. Ensure to remove any file databases / data.db from the PR.
  8. 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!

Write bug reports with detail, background, and sample code

This is an example of a bug report someone wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, another app developer.

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 I 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 Facebook's Guidelines

  • 4 spaces for indentation rather than tabs

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