Skip to content

Improve CONTRIBUTE and Add Drink Water Reminder #136

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

Merged
merged 5 commits into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ Please note that we have a code of conduct that we need to follow moving forward
We use github to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests

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:

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

## Any contributions you make will be under the MIT Software License
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.
Expand All @@ -32,7 +33,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
## Write bug reports with detail, background, and sample code
[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.

**Great Bug Reports** tend to have:
*Great Bug Reports* tend to have:

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

People *love* thorough bug reports. I'm not even kidding.
People love thorough bug reports. I'm not even kidding.

## Use a Consistent Coding Style
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`

## License
By contributing, you agree that your contributions will be licensed under its MIT License.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,4 @@ The contribution guidelines are as per the guide [HERE](https://github.com/larym
| 51 | [PDF Downloader](https://github.com/Sdccoding/Python-project-Scripts/tree/main/PDF_Downloader) | [Souhardya Das Chowdhury](https://github.com/Sdccoding)
| 52 | [ConsoleSnake](https://github.com/larymak/Python-project-Scripts/tree/main/ConsoleSnake) | [tomimara52](https://github.com/tomimara52)
| 52 | [ConsoleMinesweeper](https://github.com/larymak/Python-project-Scripts/tree/main/ConsoleMinesweeper) | [tomimara52](https://github.com/tomimara52)
| 53 | [Drink Water Reminder](https://github.com/larymak/Python-project-Scripts/tree/main/drink-water-reminder) | [Tristán Hdez](https://github.com/tristanHdez18)
32 changes: 32 additions & 0 deletions drink-remider/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Drink-Water-Reminder
<p align="center">
<img src="https://raw.githubusercontent.com/tristanHdez18/Drink-Water-Reminder/main/images/Drink_Water_Reminder_Logo.gif" alt="animated" width="250" height="250" />
</p>

### If you something forget to drink water because you're busy, this application is the best for you!

# Requirements

### You need [plyer](https://github.com/kivy/plyer) and [python3](https://www.python.org/download/releases/3.0/) installed

# Installation

```
git clone https://github.com/tristanHdez18/Drink-Water-Reminder
```

and then you need to put the next command:

For **Windows**:
```
pythonw .\main.py
```

For **Linux**:
```
python3 main.py&
```

# Credits

[Tristan](https://github.com/tristanHdez18).
14 changes: 14 additions & 0 deletions drink-remider/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import time
from plyer import notification

if __name__ == "__main__":
while True:
notification.notify(
title = "Keep in check!",
message = "You need to drink water!\nTake your time"+
" and drink your glass of water\nThe Nation Academies of Sciences, Engineering, and Medicine say:"+
" 'you need drink about 15.5 cups (3.7 liters)'",
app_icon = "../images/glass.ico",
timeout=10
)
time.sleep(60*80)
1 change: 1 addition & 0 deletions drink-remider/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
plyer