Skip to content

Commit

Permalink
major:
Browse files Browse the repository at this point in the history
desc:
- added CONTRIBUTING.md, modified README.md
  • Loading branch information
samjtro committed Dec 29, 2024
1 parent b4ff174 commit b68dbbe
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# go-schwab contribution rules
---

## testing

ALL contributions to our libraries must be tested. for go-schwab/trader, running the tests requires configuring the library, which in turn requires setting your environment variables.

follow the instructions in the README quick start to generate your tokens. after you've finished your contribution, before testing, go to `utils.go`, and uncomment lines 41 & 66-67, or the lines denoted "For Testing:".

```
41:
// "github.com/joho/godotenv"
```

```
66-67:
// err := godotenv.Load(findAllEnvFiles()...)
// isErrNil(err)
```

then, run `go test` in the trader directory. if your contribution does not pass, then don't contribute it!

if it does pass, then follow these steps:

## contributing

```
0. fork the repository
1. commit your changes
2. create a pr
```
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

built by: [@samjtro](https://github.com/samjtro) + [other amazing ppl :)](https://github.com/go-schwab/trader/graphs/contributors)

see: [CONTRIBUTING](https://github.com/go-schwab/trader/blob/main/CONTRIBUTING.md)

---

why should you use this project?
Expand Down Expand Up @@ -55,7 +57,7 @@ printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltNam

-----

`go get github.com/go-schwab/[email protected].2`
`go get github.com/go-schwab/[email protected].3`

### 0.1 agent

Expand Down

0 comments on commit b68dbbe

Please sign in to comment.