-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change template to add platform considerations #5533
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,79 @@ | ||
| # Description | ||
| # Pull Request OpenBB | ||
|
|
||
| - [ ] Summary of the change / bug fix. | ||
| ## The OpenBBTerminal | ||
|
|
||
| <details> | ||
| <summary> Pull Request for the OpenBBTerminal</summary> | ||
|
|
||
| ### 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? | ||
|
|
||
| # How has this been tested? | ||
| - Please describe the tests that you ran to verify your changes. | ||
| - Please provide instructions so we can reproduce. | ||
| - Please also list any relevant details for your test configuration. | ||
|
|
||
| * 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 | ||
| - [ ] Ensure the affected commands still execute in the OpenBB Terminal. | ||
| - [ ] Ensure the Platform (previously named SDK) is working as intended. | ||
| - [ ] Check any related reports. | ||
|
|
||
| ### Checklist | ||
|
|
||
| # Checklist: | ||
|
|
||
| - [ ] I ensure I have self-reviewed my code. | ||
| - [ ] I have commented/documented my code, particularly in hard-to-understand sections. | ||
| - [ ] 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). | ||
|
|
||
| </details> | ||
|
|
||
| ## The OpenBB Platform | ||
|
|
||
| <details> | ||
| <summary> Pull Request for the OpenBB Platform</summary> | ||
|
|
||
| ### 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. | ||
| - Please provide instructions so we can reproduce. | ||
| - Please also list any relevant details for your test configuration. | ||
|
|
||
| - [ ] Ensure all unit and integration tests pass. | ||
| - If you modified/added command(s): | ||
| - [ ] Ensure the command(s) execute with the expected output. | ||
| - [ ] API. | ||
| - [ ] Python Interface. | ||
| - [ ] If applicable, please add new tests for the command (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing). | ||
| - If a new provider was introduced or a new fetcher was added to an existing provider: | ||
| - [ ] Ensure the existing tests pass. | ||
| - [ ] Ensure the new provider and/or fetcher is stable and usable. | ||
| - [ ] If applicable, please add new tests for the provider and/or fetcher (see [CONTRIBUTING.md](/openbb_platform/CONTRIBUTING.md) to leverage semi-automated testing). | ||
|
|
||
|
|
||
| ### Checklist | ||
|
|
||
| # Others | ||
| - [ ] I have performed a self-review of my own code. | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas. | ||
| - [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`. | ||
| - [ ] I ensure that I am following th [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). | ||
| - [ ] (If applicable) I have updated tests following [these guidelines](/openbb_platform/CONTRIBUTING.md#qa-your-extension). | ||
|
|
||
|
|
||
| </details> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Err... shouldn't we provide the link to our Platform guidelines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we will still need some different guidelines for the Terminal since it will have its own particularities (despite using the Platform).