Skip to content

Commit

Permalink
Moving v2 to root.
Browse files Browse the repository at this point in the history
  • Loading branch information
cinar committed Dec 3, 2023
1 parent a19ab40 commit 919a13c
Show file tree
Hide file tree
Showing 159 changed files with 323 additions and 5,648 deletions.
28 changes: 7 additions & 21 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,17 @@ assignees: ''
---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**List References**

**Expected behavior**
A clear and concise description of what you expected to happen.
List references to your resources.

**Screenshots**
If applicable, add screenshots to help explain your problem.
**To Reproduce**

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
Provide an example demonstrating the bug.

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Expected behavior**

**Additional context**
Add any other context about the problem here.
Provide a test data showing the expected behavior.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ assignees: ''
---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
11 changes: 0 additions & 11 deletions .github/dependabot.yml

This file was deleted.

13 changes: 11 additions & 2 deletions .github/pull_request_template.md
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.
9 changes: 6 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Build

on:
push:
branches: [ "main" ]
branches: [ "main", "v2" ]
pull_request:
branches: [ "main" ]
branches: [ "main", "v2" ]

jobs:

Expand All @@ -26,14 +26,17 @@ jobs:
with:
args: ./...

- name: Run Revive
uses: docker://morphy/revive-action:v2

- name: Go fix
run: go fix ./...

- name: Go build
run: go build -v ./...

- name: Go test
run: go test -v -coverprofile=coverage.out ./...
run: go test -v -race -coverprofile=coverage.out -covermode=atomic ./...

- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v3
Expand Down
2 changes: 0 additions & 2 deletions .replit

This file was deleted.

37 changes: 37 additions & 0 deletions CONTRIBUTING.md
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!
Loading

0 comments on commit 919a13c

Please sign in to comment.