mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
Create pull_request_template.md (#1191)
* Create pull_request_template.md * Update pull_request_template.md
This commit is contained in:
29
.github/pull_request_template.md
vendored
Normal file
29
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
# Description
|
||||
|
||||
- [ ] Summary of the change / bug fix.
|
||||
- [ ] Link # issue, if applicable.
|
||||
- [ ] Screenshot of the feature or the bug before/after fix, if applicable.
|
||||
- [ ] Relevant motivation and context.
|
||||
- [ ] List any dependencies that are required for this change.
|
||||
|
||||
|
||||
# How has this been tested?
|
||||
|
||||
* Please describe the tests that you ran to verify your changes.
|
||||
* Provide instructions so we can reproduce.
|
||||
* Please also list any relevant details for your test configuration.
|
||||
|
||||
|
||||
# Checklist:
|
||||
|
||||
- [ ] Update [our Hugo documentation](https://gamestonkterminal.github.io/GamestonkTerminal/) following [these guidelines](https://github.com/GamestonkTerminal/GamestonkTerminal/tree/main/website).
|
||||
- [ ] Update our tests following [these guidelines](https://github.com/GamestonkTerminal/GamestonkTerminal/tree/main/tests).
|
||||
- [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/CONTRIBUTING.md).
|
||||
- [ ] If a feature was added make sure to add it to the corresponding [scripts file](https://github.com/GamestonkTerminal/GamestonkTerminal/tree/main/scripts).
|
||||
|
||||
|
||||
# Others
|
||||
- [ ] I have performed a self-review of my own code.
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas.
|
||||
- [ ] My code passes all the checks pylint, flake8, black, ... To speed up development you should run `pre-commit install`.
|
||||
- [ ] New and existing unit tests pass locally with my changes. You can test this locally using `pytest tests/...`.
|
||||
Reference in New Issue
Block a user