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

[Feature] CLI README #6402

Merged
merged 3 commits into from
May 13, 2024
Merged

[Feature] CLI README #6402

merged 3 commits into from
May 13, 2024

Conversation

hjoaquim
Copy link
Contributor

  1. Why? (1-3 sentences or a bullet point list):

    • CLI needs a proper README to be displayed in PyPI.
  2. What? (1-3 sentences or a bullet point list):

    • Remove CONTRIBUTING: the expectation is that contributors flow into the Platform and not the CLI.
    • Create a minimal README for the CLI that follows the same structure as the Platform and point mostly to the docs website.
    • Updates urls on the Platform README
  3. Impact (1-2 sentences or a bullet point list):

    • NA
  4. Testing Done:

    • Check cli/README.md

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels May 13, 2024
cli/README.md Outdated Show resolved Hide resolved
cli/README.md Outdated Show resolved Hide resolved
cli/README.md Outdated Show resolved Hide resolved
@IgorWounds IgorWounds self-requested a review May 13, 2024 17:14
@IgorWounds IgorWounds added this pull request to the merge queue May 13, 2024
Merged via the queue into develop with commit 4ed5f05 May 13, 2024
10 checks passed
@IgorWounds IgorWounds deleted the feature/cli-readme branch May 14, 2024 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants