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

Rearrange README content #502

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Rearrange README content #502

merged 1 commit into from
Feb 11, 2025

Conversation

tp832944
Copy link
Contributor

@tp832944 tp832944 commented Feb 11, 2025

closes: #501

PR Type

  • Documentation content changes

Description

Move testing section to CONTRIBUTING.md.

Merge examples and main READMEs.

Improve installation instructions.

Other minor improvements.

How Has This Been Tested?

Read it.

Does this PR introduce a breaking change?

No

Screenshots

Checklist before requesting a review

  • I have made sure that my PR is not a duplicate.
  • My code follows the style guidelines of this project.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have performed a self-review of my code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

Move testing section to CONTRIBUTING.md.

Merge examples and main READMEs.

Improve installation instructions.

Other minor improvements.

closes: #501
Copy link
Contributor

@gw265981 gw265981 left a comment

Choose a reason for hiding this comment

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

The README and CONTRIBUTING look great, happy to merge.

@gw265981 gw265981 merged commit c47e74c into main Feb 11, 2025
30 checks passed
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.

Improve README structure and content
2 participants