Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 1.73 KB
Raw

Contributing to SimpleDialog

We love your thoughts! 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

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:

Fork the repo and create your branch from master.

  • If you've added code that should be tested.
  • If you've changed features or added new features, update the documentation.
  • Make sure your code lints.
  • 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

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

  • use 4 spaces for indentation(tabs)
  • 80 character line length

License

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