diff --git a/.github/PULL_REQUEST_TEMPLATE/obb_developer_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/obb_developer_pull_request_template.md new file mode 100644 index 000000000000..e72cb7d66ae1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/obb_developer_pull_request_template.md @@ -0,0 +1,40 @@ +# Pull Request Template for OpenBB Developers + +0. **Title**: + + - Format: [Type] - Brief Description (e.g., [Hotfix] - Improve Calculation Accuracy). + +1. **Why**? (1-3 sentences or a bullet point list): + + - State the primary reason for this change. + + - Example: "To enhance the accuracy of our risk calculation in response to recent market volatility." + +2. **What**? (1-3 sentences or a bullet point list): + + - Describe what has been done in simple terms. + + - Example: "Updated the risk calculation algorithm to factor in real-time market fluctuations." + +3. **Impact** (1-2 sentences or a bullet point list): + + - Briefly note the expected outcome or any potential risks and share the Impact Analysis score. + + - Example: "Expected to improve risk assessment accuracy by 15%, with minimal performance impact. Impact score: 10" + + > [!TIP] + > Refer to the Impact Analysis confluence (internal) document for more information. + +4. **Testing Done**: + + - A quick note on how it was tested. + + - Example: "Validated with historical market data and simulated scenarios." + +5. **Reviewer Notes** (optional): + + - Any specific focus areas for review? + + - Example: "Please check algorithm compatibility with existing data models." + +6. **Any other information** (optional) diff --git a/.github/PULL_REQUEST_TEMPLATE/platform_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/platform_pull_request_template.md new file mode 100644 index 000000000000..0755c9b14e36 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/platform_pull_request_template.md @@ -0,0 +1,40 @@ +# Pull Request the OpenBB Platform + +## 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). +- If a new provider or extension was added: + - [ ] Update the list of [Extensions](/openbb_platform/EXTENSIONS.md). + - [ ] Update the list of [Providers](/openbb_platform/PROVIDERS.md). + - [ ] If it's a community extension or provider, update the [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml). + +## Checklist + +- [ ] 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 the [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). + + diff --git a/.github/PULL_REQUEST_TEMPLATE/terminal_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/terminal_pull_request_template.md new file mode 100644 index 000000000000..351d7049307a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/terminal_pull_request_template.md @@ -0,0 +1,29 @@ +# Pull Request the OpenBBTerminal + +## 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 the affected commands still execute in the OpenBB Terminal. +- [ ] Ensure the Platform (previously named SDK) is working as intended. +- [ ] Check any related reports. + +## 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). diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3df72068a852..fb04004546a6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,80 +1,7 @@ # Pull Request OpenBB -## The OpenBBTerminal +Please go the the `Preview` tab and select the appropriate PR sub-template: -
- Pull Request for the OpenBBTerminal - -### 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 the affected commands still execute in the OpenBB Terminal. -- [ ] Ensure the Platform (previously named SDK) is working as intended. -- [ ] Check any related reports. - -### 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). - -
- -## The OpenBB Platform - -
- Pull Request for the OpenBB Platform - -### 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). -- If a new provider or extension was added: - - [ ] Update the list of [Extensions](/openbb_platform/EXTENSIONS.md). - - [ ] Update the list of [Providers](/openbb_platform/PROVIDERS.md). - - [ ] If it's a community extension or provider, update the [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml). - -### Checklist - -- [ ] 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 the [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). - -
+* [OpenBB Platform](?expand=1&template=platform_pull_request_template.md) +* [OpenBB Terminal](?expand=1&template=terminal_pull_request_template.md) +* [OpenBB Developers](?expand=1&template=obb_developer_pull_request_template.md)