-
Notifications
You must be signed in to change notification settings - Fork 368
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
Review and update documentation #773
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
I just left a suggestion that you could ignore because I think it might be a matter of taste
One goal to have in mind - make sure the documentation features all the information you'd like to see there as a newcomer to the project. That's our bar for success. :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @Vitalina-Vakulchyk, I'll do a couple of additions later today and ping you. :-)
@toptal-anvil ping reviewers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
In the main README.md:
Commit message starts with[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).Added tests.Added an entry to the changelog if the new code introduces user-observable changes. See changelog entry format for details.