Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.56 KB

Contributing to Indicator

Welcome to the Indicator library! We appreciate your interest in contributing. Before you start, please take a moment to read our Contributor Covenant Code of Conduct.

Who Can Contribute?

Anyone is welcome to contribute to the Indicator library. No prior experience is required, but having some knowledge of coding is helpful.

How to Contribute?

Finding a Bug?

  1. Check if the bug has already been reported by searching Project Issues.
  2. If no open issue addresses the problem, create a new one.
  3. Use the relevant bug report templates, providing a clear title, detailed description, and, if possible, a code sample or executable test case demonstrating the issue.

Writing a Fix?

  1. Open a new GitHub pull request with your patch.
  2. The project maintainers will review pull requests, merging them if they meet coding standards and are approved.

Coding Standards

The project adheres to Go coding standards.

Code Quality

  • The Indicator library maintains 100% code coverage for reliability.
  • Test cases are located in _test.go files, covering all possible scenarios for user input validation.
  • Clearly explain each function and provide references.

Pull Requests

  • Ensure code coverage remains at 100% by adding sufficient test cases.
  • Test large data sets using CSV files.

Thank you for contributing to make the Indicator library better. Your efforts help ensure the reliability and correctness of user data handling. We look forward to your contributions!