Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.39 KB

Contributing to SmartScanner Core

Thank you for your interest to contribute to SmartScanner Core! We want to make contributing to this project as easy as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Git Workflow

We use Gitflow as our Git workflow, and all code changes happen through pull requests. Your pull requests to the codebase are very much welcome:

  1. Fork the repo and create your branch from develop.
  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.
  5. Open that pull request!

Reporting bugs

We use GitHub issues to track bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code. An issue template is provided when opening a new issue, make sure to provide all the requested information to make it easier to address the issue.

License

By contributing, you agree that your contributions will be licensed under its Apache-2.0 License.