diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c7b72bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# contributing to go-schwab/trader + +contributing to this project is very easy! development happens on the [dev](https://github.com/go-schwab/trader/tree/dev) branch. the goal is for the main branch to remain essentially unchanged (barring library-breaking behavior) until the next semantic release, to keep things as stable as possible. + +--- + +BEFORE DOING ANY OF THIS, YOU MUST TEST YOUR CHANGES BY RUNNING GO TEST. + +IF YOUR CODE DOESNT PASS OUR CI TESTS, YOUR PR WILL NOT BE REVIEWED KINDLY :) + +0. create a fork +1. commit your changes +2. create a pull request to the dev branch, preferably with the following description: + +``` +major | minor: +ref: [issue] #_ | [pr] v_._._ +desc: +- ... +``` diff --git a/README.md b/README.md index 8c60188..546f9af 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,10 @@ [![License](https://img.shields.io/badge/License-GPLv2-green)](LICENSE) built by [@samjtro](https://github.com/samjtro) +see: [CONTRIBUTING.md](https://github.com/go-schwab/trader/blob/main/CONTRIBUTING.md) --- -if you want to contribute - go for it! there is no contribution guide, just a simple golden rule: if it ain't broke, don't fix it: -**all** contributions should be tested via `go test` before submission. - why should you use this project? - lightning fast @@ -24,7 +22,7 @@ why should you use this project? ### 0.0 quick start 0. go to , create an account, create an app, get app credentials from -1. create `config.env` in your project directory, formatted as such: +1. create any file with the `.env` extension in your project directory (can also have multiple, if necessary), formatted as such: ``` APPKEY=KEY0 // App Key @@ -32,7 +30,7 @@ SECRET=KEY1 // App Secret CBURL=https://127.0.0.1 // App Callback URL ``` -2. `go get github.com/go-schwab/trader@v0.5.1` +2. `go get github.com/go-schwab/trader@v0.9.0` ### 0.1 agent