Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.58 KB

Contributing to json-masker

We very much welcome your input! We want to make contributing to this project as easy and transparent as possible, whether it is:

  • Reporting a bug
  • Discussing additional features
  • Submitting a fix
  • Reporting a security vulnerability

We develop with Github

We use GitHub to host the code, have discussions about (additional) features, track issues, as well as accept pull requests.

All code changes happen through pull requests

To contribute to this project, please open a pull request as follows:

  1. Create a fork of the repository and branch from the master branch
  2. If you've added any new functionality, make sure to add full test coverage
  3. If you've changed APIs, update the JavaDoc
  4. Ensure the test suite passes
  5. Make sure the line-length your code is 120 characters
  6. Open your pull request on GitHub

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. Feel free to report a bug by opening a new issue.

Writing a proper bug report

Proper bug reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • Sample code, if possible
  • 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)