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

Changes to readme for installation steps #225

Merged
merged 10 commits into from
Dec 14, 2024
Merged

Changes to readme for installation steps #225

merged 10 commits into from
Dec 14, 2024

Conversation

andram11
Copy link
Contributor

@andram11 andram11 commented Nov 22, 2024

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Issue link

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature updates / changes
  • Tests
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

I assume no testing needed for this kind of change

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • 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 tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have updated the change log

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@cherylli cherylli left a comment

Choose a reason for hiding this comment

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

Looks good, we could add that link Dan posted and also please also update the changelog. Thanks!

CHANGELOG.md Outdated Show resolved Hide resolved
Removed extra-spaces caused by my auto-formatter
Copy link
Contributor

@cherylli cherylli left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for the update!

CHANGELOG.md Show resolved Hide resolved
@cherylli
Copy link
Contributor

Thanks for the update but it seems there are also a few other files changed with the new update. The formatting seems to match the prettier file which changed the tabWidth from 2-4, were these files not formatted by husky @timDeHof ? these look like your latest changes

Copy link
Contributor

@cherylli cherylli left a comment

Choose a reason for hiding this comment

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

thanks!

@cherylli
Copy link
Contributor

@JoshuaHinman are you able to review this please. If not we can see if anyone else is available to review this

Copy link
Contributor

@JoshuaHinman JoshuaHinman left a comment

Choose a reason for hiding this comment

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

Look great!

@andram11 andram11 merged commit e94c2ba into dev Dec 14, 2024
1 check passed
@andram11 andram11 deleted the update/update-readme branch December 14, 2024 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants