mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 20:42:26 +00:00
92360a7124
* Update PR template and contributing guide * get rid of the merge group because it failed * Markdown lint * Update the merge group type * bugfix -> hotfix --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
32 lines
1.6 KiB
Markdown
Vendored
32 lines
1.6 KiB
Markdown
Vendored
# 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.
|
|
- [ ] Make sure affected commands still run in terminal
|
|
- [ ] Ensure the SDK still works
|
|
- [ ] Check any related reports
|
|
|
|
|
|
# Checklist:
|
|
|
|
- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
|
|
- [ ] Update [our documentation](https://openbb-finance.github.io/OpenBBTerminal/) following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/website). Update any user guides that are affected by the changes.
|
|
- [ ] Update our tests following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/tests).
|
|
- [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
|
|
- [ ] If a feature was added make sure to add it to the corresponding [integration test script](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/integration_tests_scripts).
|
|
|
|
|
|
# Others
|
|
- [ ] I have performed a self-review of my own code.
|
|
- [ ] I have commented my code, particularly in hard-to-understand areas.
|