mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
Added .github folder for issue, contrib, and PR templates. (#200)
* Added .github folder for issue, contrib, and PR templates. * Requested changes to templates * Improved templates
This commit is contained in:
committed by
Adrian Gallagher
parent
c1b2959606
commit
506940587e
13
doc/coding_style.md → .github/CONTRIBUTING.md
vendored
13
doc/coding_style.md → .github/CONTRIBUTING.md
vendored
@@ -1,5 +1,10 @@
|
||||
Coding Style
|
||||
===============
|
||||
# Contributing
|
||||
|
||||
## Please contribute
|
||||
|
||||
All PR's are welcome
|
||||
|
||||
## Coding Style
|
||||
|
||||
In order to maintain a consistent style across the codebase, the following coding style has been adopted:
|
||||
|
||||
@@ -8,7 +13,7 @@ In order to maintain a consistent style across the codebase, the following codin
|
||||
- Variable names use CamelCase (var someVar()).
|
||||
- Coding style uses gofmt.
|
||||
- Const variables are CamelCase depending on exported items.
|
||||
- In line with gofmt, for loops and if statements don't require paranthesis.
|
||||
- In line with gofmt, for loops and if statements don't require parenthesis.
|
||||
|
||||
Block style example:
|
||||
```go
|
||||
@@ -29,4 +34,4 @@ func SendHTTPRequest(method, path string, headers map[string]string, body io.Rea
|
||||
}
|
||||
...
|
||||
}
|
||||
```
|
||||
```
|
||||
33
.github/ISSUE_TEMPLATE.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
# New Issue
|
||||
|
||||
## Context
|
||||
|
||||
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
|
||||
|
||||
* Operating System:
|
||||
|
||||
* GoCryptoTrader version (`gocryptotrader -version`):
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
Please describe the behavior you are expecting
|
||||
|
||||
## Current Behavior
|
||||
|
||||
What is the current behavior?
|
||||
|
||||
## Failure Information (for bugs)
|
||||
|
||||
Please help by providing information about the failure. If it is not a bug, please remove the rest of this template.
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
Please provide detailed steps for reproducing the issue.
|
||||
|
||||
1. step 1
|
||||
2. step 2
|
||||
3. step 3...
|
||||
|
||||
### Failure Logs
|
||||
|
||||
By default, GoCryptoTrader stores its `debug.log` file in `%APPDATA%\GoCryptoTrader` on Windows and `~/.gocryptotrader` on Linux/Unix/macOS. Raw text or a link to a pastebin type site is preferred.
|
||||
34
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
34
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||
|
||||
Fixes # (issue)
|
||||
|
||||
## Type of change
|
||||
|
||||
Please delete options that are not relevant and add an `x` in `[]` as item is complete.
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
# How Has This Been Tested?
|
||||
|
||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
|
||||
|
||||
## Please also consider improving test coverage whilst working on a certain package
|
||||
|
||||
- [ ] Test A
|
||||
- [ ] Test B
|
||||
|
||||
# Checklist:
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation and regenerated documentation via the documentation tool
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally and on Travis with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
Reference in New Issue
Block a user