Skip to content

Commit 3df894e

Browse files
authored
Merge pull request larymak#136 from tristanHdez18/main
Improve CONTRIBUTE and Add Drink Water Reminder
2 parents 465088a + 13a0772 commit 3df894e

File tree

5 files changed

+54
-4
lines changed

5 files changed

+54
-4
lines changed

CONTRIBUTING.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ Please note that we have a code of conduct that we need to follow moving forward
1313
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1414

1515
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
1617
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1718

18-
1. Fork the repo and create your branch from `main`.
19+
1. Fork the repository and create your branch from `main`.
1920
2. If you've added code that should be tested, add tests.
2021
3. If you've changed APIs, update the documentation.
2122
4. Ensure the test suite passes.
2223
5. Make sure your code lints.
2324
6. Issue that pull request!
24-
7. Always add a READme to your added code.
25+
7. Always add a `README` and/or `requirements.txt` to your added code.
2526

2627
## Any contributions you make will be under the MIT Software License
2728
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
@@ -32,7 +33,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
3233
## Write bug reports with detail, background, and sample code
3334
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
3435

35-
**Great Bug Reports** tend to have:
36+
*Great Bug Reports* tend to have:
3637

3738
- A quick summary and/or background
3839
- Steps to reproduce
@@ -42,9 +43,10 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
4243
- What actually happens
4344
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
4445

45-
People *love* thorough bug reports. I'm not even kidding.
46+
People love thorough bug reports. I'm not even kidding.
4647

4748
## Use a Consistent Coding Style
49+
You can check [here](https://docs.python-guide.org/writing/style/) for more information about a good coding style. It's important to respect and follow it up to keep good practices. If it's difficult for you please, take in consideration use `flake8`
4850

4951
## License
5052
By contributing, you agree that your contributions will be licensed under its MIT License.

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,4 @@ The contribution guidelines are as per the guide [HERE](https://github.com/larym
9595
| 51 | [PDF Downloader](https://github.com/Sdccoding/Python-project-Scripts/tree/main/PDF_Downloader) | [Souhardya Das Chowdhury](https://github.com/Sdccoding)
9696
| 52 | [ConsoleSnake](https://github.com/larymak/Python-project-Scripts/tree/main/ConsoleSnake) | [tomimara52](https://github.com/tomimara52)
9797
| 52 | [ConsoleMinesweeper](https://github.com/larymak/Python-project-Scripts/tree/main/ConsoleMinesweeper) | [tomimara52](https://github.com/tomimara52)
98+
| 53 | [Drink Water Reminder](https://github.com/larymak/Python-project-Scripts/tree/main/drink-water-reminder) | [Tristán Hdez](https://github.com/tristanHdez18)

drink-remider/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Drink-Water-Reminder
2+
<p align="center">
3+
<img src="https://raw.githubusercontent.com/tristanHdez18/Drink-Water-Reminder/main/images/Drink_Water_Reminder_Logo.gif" alt="animated" width="250" height="250" />
4+
</p>
5+
6+
### If you something forget to drink water because you're busy, this application is the best for you!
7+
8+
# Requirements
9+
10+
### You need [plyer](https://github.com/kivy/plyer) and [python3](https://www.python.org/download/releases/3.0/) installed
11+
12+
# Installation
13+
14+
```
15+
git clone https://github.com/tristanHdez18/Drink-Water-Reminder
16+
```
17+
18+
and then you need to put the next command:
19+
20+
For **Windows**:
21+
```
22+
pythonw .\main.py
23+
```
24+
25+
For **Linux**:
26+
```
27+
python3 main.py&
28+
```
29+
30+
# Credits
31+
32+
[Tristan](https://github.com/tristanHdez18).

drink-remider/main.py

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import time
2+
from plyer import notification
3+
4+
if __name__ == "__main__":
5+
while True:
6+
notification.notify(
7+
title = "Keep in check!",
8+
message = "You need to drink water!\nTake your time"+
9+
" and drink your glass of water\nThe Nation Academies of Sciences, Engineering, and Medicine say:"+
10+
" 'you need drink about 15.5 cups (3.7 liters)'",
11+
app_icon = "../images/glass.ico",
12+
timeout=10
13+
)
14+
time.sleep(60*80)

drink-remider/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
plyer

0 commit comments

Comments
 (0)