Merge pull request #11 from elkopass/dev

Version 0.1.2

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce (optional)**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots and references**
+If applicable, add screenshots or links to the code to help explain your problem.
+
+**Platform and runtime**
+ - OS: [e.g. Ubuntu]
+ - Bot version [e.g. 0.1.1]
+ - Go version [e.g. 1.18]
+
+**Additional context (optional)**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+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.

.github/PULL_REQUEST_TEMPLATE/template.md

@@ -0,0 +1,12 @@
+# Description
+
+**Fixes (optional):** ...
+
+**Changes** proposed by this PR:
+
+- ...
+- ...
+- ...
+
+----
+*P.S. ping me if you really need to:* @somnoynadno ヽ(´▽`)/

.github/workflows/codeql.yml

@@ -0,0 +1,38 @@
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ main ]
+ pull_request:
+ branches: [ main ]
+ schedule:
+ - cron: '39 19 * * 4'
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'go' ]
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: ${{ matrix.language }}
+
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v2
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2

.github/workflows/main.yml

@@ -3,7 +3,7 @@ name: CI
 on:
  push:
  paths:
- - '.github/**'
+ - '.github/workflows/**'
  - 'cmd/**'
  - 'internal/**'
 

.github/workflows/pages.yml

@@ -3,7 +3,7 @@ name: mkdocs
 on:
  push:
  paths:
- - '.github/**'
+ - '.github/workflows/**'
  - 'docs/**'
  - 'mkdocs.yml'
 

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+-----
+
+By contributing, you agree that your contributions will be licensed under its Apache 2.0 license.

README.md

@@ -22,7 +22,7 @@ This bot is fully configurable with environment variables
 using [envconfig](https://github.com/kelseyhightower/envconfig) library.
 
 You can find full list of them in our 
-[.env-example](https://github.com/elkopass/BITA/blob/main/cmd/trade-bot/.env-example) file.
+[.env-example](cmd/trade-bot/.env-example) file.
 
 Right before we started, obtain your Tinkoff Invest API token in 
 [settings](https://www.tinkoff.ru/invest/settings/) and set it as follows: `TRADEBOT_TOKEN=<your_api_token>`.
@@ -59,19 +59,23 @@ It is very important to create alert rules on key trade actions to
 prevent possible money losses
 
 This is why our service exports a lot of useful 
-[metrics](https://github.com/elkopass/BITA/blob/main/internal/metrics/metrics.go) 
+[metrics](internal/metrics/metrics.go) 
 for you to configure your own monitoring.
 
 **Check out our cool Grafana dashboard [>> here <<](https://bita.somnoynadno.ru)**
 
 You can always download and import the latest version from 
-[JSON file](https://github.com/elkopass/BITA/tree/main/.grafana/TradeBot.json) 
+[JSON file](.grafana/TradeBot.json) 
 for your own installation. 
 
+## Contributing
+
+If you want to support this project, check our [contributing guideline](CONTRIBUTING.md).
+
 ## Disclaimer
 
 The developers are NOT RESPONSIBLE for any financial losses incurred 
 during the use of the trading bot.
 
 This project is released under the Apache License.
-See [LICENSE](https://github.com/elkopass/BITA/blob/main/LICENSE) for details.
+See [LICENSE](LICENSE) for details.