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.

Sign up for GitHub

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

Jump to bottom

Improve project README #28

Merged
merged 2 commits into from
Mar 5, 2024
Merged

Improve project README #28

merged 2 commits into from
Mar 5, 2024

Conversation

pleshakov
Copy link
Contributor

@pleshakov pleshakov commented Feb 29, 2024 •
edited
Loading

Proposed changes

Problem:
Project README is empty

Solution:
Add content to project README.

CLOSES #6

Note:
How to use the project - that will be added in #5

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING
    guide
  • I have proven my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have ensured the README is up to date
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch on my own fork

@pleshakov
Improve project README
6cc0c8c 
Problem:
Project README is empty

Solution:
Add content to project README.
@pleshakov pleshakov requested a review from a team as a code owner February 29, 2024 18:05
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Feb 29, 2024
@pleshakov pleshakov merged commit 241de02 into main Mar 5, 2024
10 checks passed
@pleshakov pleshakov deleted the doc/readme branch March 5, 2024 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucacome lucacome lucacome approved these changes

@kate-osborn kate-osborn kate-osborn approved these changes

@shaun-nx shaun-nx shaun-nx approved these changes

@bjee19 bjee19 bjee19 approved these changes

Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve project README
5 participants
@pleshakov @lucacome @kate-osborn @shaun-nx @bjee19