|
1 | 1 | # Self review checklist ✅ |
2 | 2 |
|
3 | | -Before creating a pull request you should check the following requirements that must be addressed before a PR will be accepted. |
| 3 | +Before creating a pull request you should check the following requirements that |
| 4 | +must be addressed before a PR will be accepted. |
4 | 5 |
|
5 | 6 | - [ ] **All** pre-commit hooks must run through - successfully. |
6 | | -- [ ] Make sure that the changes confirm the coding style of the [python-kraken-sdk](https://github.com/btschwertfeger/python-kraken-sdk). Most issues will be resolve through the pre-commit hooks. |
7 | | -- [ ] Also take care to follow the community guidelines and the [Code of Conduct](./CODE_OF_CONDUCT.md). |
8 | | -- [ ] Self-review your changes to detect typos, syntax errors and any kind of unwanted behavior. |
9 | | -- [ ] If you changed the source code you have to **ensure that all unit tests run through**. If you added a new function you also have to **write a test** for that. Also make sure to **follow the doc string style** of the package and **provide at least one working example** within a function doc string. This is important since doc strings will be reflected within the documentation. |
10 | | -- [ ] Take your time to prepare your code before creating a PR. A good PR will save a lot of time for everyone. |
11 | | -- [ ] There are several workflows/actions within this repository. Any relevant workflow must be run successfully within your fork. In the following these workflows are listed, but **please also read the respective workflow files to get further information**. |
12 | | - - PR Manual Pre-Commit (`manual_pre_commit.yaml`): This workflow must be green in any case. |
| 7 | +- [ ] Make sure that the changes confirm the coding style of the |
| 8 | + [python-kraken-sdk](https://github.com/btschwertfeger/python-kraken-sdk). Most |
| 9 | + issues will be resolve through the pre-commit hooks. |
| 10 | +- [ ] Also take care to follow the community guidelines and the [Code of |
| 11 | + Conduct](./CODE_OF_CONDUCT.md). |
| 12 | +- [ ] Self-review your changes to detect typos, syntax errors and any kind of |
| 13 | + unwanted behavior. |
| 14 | +- [ ] If you changed the source code you have to **ensure that all unit tests |
| 15 | + run through**. If you added a new function you also have to **write a test** |
| 16 | + for that. Also make sure to **follow the doc string style** of the package and |
| 17 | + **provide at least one working example** within a function doc string. This is |
| 18 | + important since doc strings will be reflected within the documentation. |
| 19 | +- [ ] Take your time to prepare your code before creating a PR. A good PR will |
| 20 | + save a lot of time for everyone. |
| 21 | +- [ ] There are several workflows/actions within this repository. Any relevant |
| 22 | + workflow must be run successfully within your fork. In the following these |
| 23 | + workflows are listed, but **please also read the respective workflow files to |
| 24 | + get further information**. |
| 25 | + - PR Manual Pre-Commit (`manual_pre_commit.yaml`): This workflow must be green |
| 26 | + in any case. |
13 | 27 | - PR Manual Build (`manual_build.yaml`): Must be green in any case. |
14 | 28 | - PR Manual CodeQL (`manual_codeql.yaml`): same here |
15 | | - - PR Manual Test Spot (`manual_test_spot.yaml`): If any Spot related change happened |
16 | | - - PR Manual Test Futures (`manual_test_futures.yaml`): For any Futures related changes |
17 | | - - CI/CD (`cicd.yaml`): Can be used to run all actions at once - but requires having API keys for Spot, Futures and the Futures demo environment. |
| 29 | + - PR Manual Test Spot (`manual_test_spot.yaml`): If any Spot related change |
| 30 | + happened |
| 31 | + - PR Manual Test Futures (`manual_test_futures.yaml`): For any Futures related |
| 32 | + changes |
| 33 | + - CI/CD (`cicd.yaml`): Can be used to run all actions at once - but requires |
| 34 | + having API keys for Spot, Futures and the Futures demo environment. |
0 commit comments