Skip to content

Commit

Permalink
major:
Browse files Browse the repository at this point in the history
ref: #67, v0.9.0
desc:
- added CONTRIBUTING.md, made more changes to README.md
  • Loading branch information
samjtro committed Oct 29, 2024
1 parent 3d9d0ff commit f64c618
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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:
- ...
```
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,15 +22,15 @@ why should you use this project?
### 0.0 quick start

0. go to <https://developer.schwab.com>, create an account, create an app, get app credentials from <https://developer.schwab.com/dashboard/apps>
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
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

Expand Down

0 comments on commit f64c618

Please sign in to comment.