Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 2.65 KB
Raw

Contributing to WinFormMarkup

Any input or assistance is greatly appreciated! I 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

Develop with Github

I 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). Pull requests are welcomed and encouraged:

  1. Fork the repo and create your branch from main.
  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. [TODO]
  5. Make sure your code lints. [TODO]
  6. Issue that pull request! [TODO]

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

This project will 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 well written bug report. Here's another example.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • 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

This application is being devloped using Resharper and/or JetBrains Rider. Default JetBrains C# coding styles will prevail eventually. Please code in accordance with these conventions

License

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

References

This document was adapted from "A basic template for contributing guidelines..." Gist of Brain A. Danielak (braindk)