-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
Improves the existing documentation #7
Conversation
Signed-off-by: Jürgen Löhel <[email protected]>
Signed-off-by: Jürgen Löhel <[email protected]>
Signed-off-by: Jürgen Löhel <[email protected]>
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every |
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.
"Each one helps" or something different instead of "Every little bit helps"
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.
Okay, I'll change it later.
|
||
Now you can make your changes locally. | ||
|
||
4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command:: |
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.
you are
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.
You are right, I should not shorten it.
|
||
5. Commit your changes and push your branch to GitHub:: | ||
|
||
git add . |
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.
should the dot be there?
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.
Yes, the dot is necessary.
Fixes: #2
Signed-off-by: Jürgen Löhel [email protected]