Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 2.31 KB

Contributing to FastANPR

First off, thank you for considering contributing to FastANPR. It's people like you that make FastANPR such a great tool.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for FastANPR. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for FastANPR, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Check the Issues for a similar suggestion.
  • When you are creating an enhancement suggestion, please include as many details as possible, including the reason for the enhancement and any specific use cases.

Pull Requests

The process described here has several goals:

  • Maintain FastANPR's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible FastANPR
  • Enable a sustainable system for FastANPR's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Thank you for contributing to FastANPR, and we look forward to your contributions!