Contributing

Contributing to JSON Cut

Welcome! Your contributions are valued; bug reports, code contributions, documentation improvements, helping answer posted questions, etc.

Open Source should be fun; be courteous, be respectful and enjoy. This project adheres to the following Code of Conduct.

New Contributor to Open Source?

If you've never contributed to Open Source before some projects can be a little bit scary; have no fear, this project is gentle, it doesn't bite. JSON Transformation micro-packages are intentionally simple; i.e. Occam's Razor, and are a great place to start.

As with most any Open Source project contributions will be reviewed and it's important to understand that it's normal to receive constructive feedback, to have submissions kicked back for rework, and have new features or ideas rejected if the project maintainer believes they're outside the project scope. If this happens to you, please don't take it personally; with the right attitude contributing to Open Source can be rewarding, a great way to learn, and a lot fun.

Resources:

• How-To Make a Pull Request
• How-To Contribute a Patch

Reporting Issues

• Make an attempt to avoid raising duplicate issues; please search existing

issues first.

• When reporting bugs, please use a clear, descriptive title, include

details about when the error occurred, the steps needed to reproduce the problem, along complete tracebacks.

Contributing Code and Docs

Style Guidelines

• Style Guide for Python Code (PEP8).
• How to Write Git Commit Messages.
• reStructuredText (reST) for Documentation.

Testing Guidelines

• Use pytest.
• Use flake8.
• User tox.
• For bug fixes, create a test that fails with the current code and then

passes when the fix is applied. * Ensure all tests pass before committing code.