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

Improves the existing documentation #7

Closed
wants to merge 3 commits into from
Closed

Improves the existing documentation #7

wants to merge 3 commits into from

Conversation

jloehel
Copy link
Collaborator

@jloehel jloehel commented Jul 17, 2020

  • Adds Alba as an author

Fixes: #2

Signed-off-by: Jürgen Löhel [email protected]

Signed-off-by: Jürgen Löhel <[email protected]>
@jloehel jloehel requested a review from alba-vcl July 17, 2020 01:35
@jloehel jloehel self-assigned this Jul 17, 2020
@jloehel jloehel added the documentation Improvements or additions to documentation label Jul 17, 2020
@jloehel jloehel added this to the v1.0 milestone Jul 17, 2020
@jloehel jloehel linked an issue Jul 17, 2020 that may be closed by this pull request
10 tasks
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
Copy link
Collaborator

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"

Copy link
Collaborator Author

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::
Copy link
Collaborator

Choose a reason for hiding this comment

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

you are

Copy link
Collaborator Author

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 .
Copy link
Collaborator

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?

Copy link
Collaborator Author

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.

@jloehel jloehel marked this pull request as ready for review October 23, 2020 23:36
@jloehel jloehel closed this Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a basic documentation for the project with sphinx.
2 participants