Skip to content

Commit

Permalink
update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
JaDogg committed Feb 19, 2024
1 parent 82f929c commit 24a6936
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@

# Commits
* Please put a meaningful commit message.
* No need for emojis. ❌
### OK:
* Create CSV file with statistics funcionality.
* No need for emojis in commit messages. ❌ (OK in Documentation)

**OK:**

* Create CSV file with statistics functionality.
* Fixes issue #123 - Refactor Tomato class
* Formatted with black
* Fixed README
* Updated README
* Update CONTRIBUTING.md
### Not OK:

**Not OK:**

* Push code.
* I'm pushing code..
* Gah! have some code.
Expand Down
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Install via snap (Linux):
$ sudo snap install pydoro
$ pydoro
* NOTE: Pop!_OS users will need to run pydoro without sound, using this command option: :code:`pydoro --no-sound`
* Snap package is maintained by James Tigert ( kz6fittycent_ )

Expand All @@ -56,7 +56,7 @@ If you have pipx:
.. code-block::
$ pipx install pydoro
You can also inject dependencies to pipx virtual environment using

.. code-block::
Expand Down Expand Up @@ -126,6 +126,6 @@ Why ? 🤔

Copyright ⚖
----------------
This software is Copyright (c) 2021 - 2023 Bhathiya Perera.
This software is Copyright (c) 2021 - 2024 Bhathiya Perera.

See the LICENSE file for more information.

0 comments on commit 24a6936

Please sign in to comment.