-
-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
159 changed files
with
323 additions
and
5,648 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,18 @@ | ||
# Describe Request | ||
|
||
Please describe your request. | ||
Please describe your request. Fixed # (issue). | ||
|
||
Fixed # (issue) | ||
- [ ] Code coverage is maintained or increased. | ||
- [ ] All parameters are configurable. | ||
- [ ] Test data file provided. | ||
- [ ] Links to any references. | ||
|
||
# Change Type | ||
|
||
What is the type of this change. | ||
|
||
- [ ] New indicator is added. | ||
- [ ] New strategy is added. | ||
- [ ] Other improvments. | ||
- [ ] Code maintenance. | ||
- [ ] Bug fix. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# 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](./CODE_OF_CONDUCT.md). | ||
|
||
## 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](https://github.com/cinar/indicator/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! |
Oops, something went wrong.