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

Update Repo README.md #7

Merged

Conversation

Romazes
Copy link
Contributor

@Romazes Romazes commented Jan 22, 2024

Description

This pull request introduces an improvement to the repository description to provide a more informative and comprehensive overview of the project. The changes aim to articulate the purpose, goals, and key features of the repository in a clear and concise manner, enhancing its visibility and accessibility to potential contributors and users.

Related Issue

N/A

Motivation and Context

The motivation behind enhancing the repository description is to make the project more appealing and understandable to visitors. A well-crafted description serves as the first point of contact for individuals exploring the repository. By offering a concise yet informative summary, we aim to attract contributors, users, and collaborators, fostering a better understanding of the project's scope and objectives.

Requires Documentation Change

N/A

How Has This Been Tested?

Testing for this pull request involves manual inspection of the updated repository description to ensure it effectively communicates the intended information.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

Copy link
Member

@Martin-Molinero Martin-Molinero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 👍

@Martin-Molinero Martin-Molinero merged commit 5c029e8 into QuantConnect:master Jan 22, 2024
1 check passed
@Romazes Romazes deleted the feature-update-repo-readme branch February 1, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants