Skip to content
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

[Enhancement] - Cleanup docs #6254

Merged
merged 3 commits into from
Mar 25, 2024
Merged

[Enhancement] - Cleanup docs #6254

merged 3 commits into from
Mar 25, 2024

Conversation

IgorWounds
Copy link
Contributor

  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."

@IgorWounds IgorWounds added the platform OpenBB Platform label Mar 25, 2024
@github-actions github-actions bot added the enhancement Enhancement label Mar 25, 2024
@IgorWounds IgorWounds added this pull request to the merge queue Mar 25, 2024
Merged via the queue into develop with commit 0f44128 Mar 25, 2024
7 checks passed
@IgorWounds IgorWounds deleted the feature/cleanup-docs branch March 25, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants