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

Modified readme according to #312. #315

Merged
merged 3 commits into from
Jul 31, 2024

Conversation

Simone-de-Rijke
Copy link
Contributor

@Simone-de-Rijke Simone-de-Rijke commented Jul 31, 2024

Description

Edited readme according to 312.
314 will follow later.

Fixes #312

Checklist:

  • I have added tests that prove my fix is effective or that my feature works
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes

@Simone-de-Rijke Simone-de-Rijke linked an issue Jul 31, 2024 that may be closed by this pull request
4 tasks
Copy link

Thank you so much for contributing to Blueprints! This is your Pull Request # 1 to this project.
Your contributions help thousands of engineers work more efficiently and accurately.

Now that you've created your pull request, please don't go away; take a look at the bottom of this page for the automated checks that should already be running. If they pass, great! If not, please click on 'Details' and see if you can fix the problem they've identified. A maintainer should be along shortly to review your pull request and help get it added!

@Simone-de-Rijke Simone-de-Rijke added the generic generic issue label Jul 31, 2024
@Simone-de-Rijke Simone-de-Rijke requested review from egarciamendez, RamiEvans and bjlvandergaag and removed request for egarciamendez July 31, 2024 09:13
@Simone-de-Rijke Simone-de-Rijke self-assigned this Jul 31, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@RamiEvans RamiEvans 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 overall. Slight spelling / grammar issues

Copy link
Contributor

@RamiEvans RamiEvans left a comment

Choose a reason for hiding this comment

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

All comments closed and adjustments made to general grammar and spelling

@egarciamendez egarciamendez merged commit 30c70cf into main Jul 31, 2024
4 checks passed
@egarciamendez egarciamendez deleted the 312-documentation-issue-improving-the-readme branch July 31, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
generic generic issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📚 Documentation Issue]: Improving the readme
3 participants