From 9207c9edf9ba0a1f4e21793b65d7d6431684d2a0 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Thu, 6 Jan 2022 22:30:25 +0100 Subject: [PATCH 01/10] New Head --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9ca0c812..d45c6544 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -
- -| ๐Ÿ“ข Version 0.9 is Out! Get it [here](https://github.com/sumeshir26/TimerX/releases)! ๐ŸŽ‰ -| --- - - -
+

+ TimerX Logo +

TimerX

+

-# TimerX icon TimerX +

+ + Releases + +

### A simple, lightweight, & beautiful timer app built in Python and tkinter.ttk using rdbende's [Sun Valley TTk Theme](https://github.com/rdbende/Sun-Valley-TTk-Theme) From 0eebc15156e065ba52650a390810777b01fbe115 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Fri, 7 Jan 2022 13:56:27 +0100 Subject: [PATCH 02/10] Add requested badges looks like sh!t --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index d45c6544..8ff4ce26 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,21 @@ Releases + + Python + + + Gitpod + + + Vercel + + + Actions + + + Repl.it +

### A simple, lightweight, & beautiful timer app built in Python and tkinter.ttk using rdbende's [Sun Valley TTk Theme](https://github.com/rdbende/Sun-Valley-TTk-Theme) From 93565d7966646d97b4a80e734cf88dc7db87f660 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Sat, 8 Jan 2022 09:49:15 +0100 Subject: [PATCH 03/10] Made release badge bigger --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e1b107c..f4559632 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- Releases + Releases Python From 51e2fec5ce8154e11d86fa41ae78fd3adfd2233e Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Sat, 8 Jan 2022 10:46:19 +0100 Subject: [PATCH 04/10] Create CONTRIBUTING.md --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..bf51e7ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contribute to TimerX + +TimerX is written in **Python**, so you have to install it if you want to contribute. +You can download the latest version [here](https://www.python.org/downloads/release/python-3101/). +Make sure to check `Add python 3.10 to path` when installing it. + +When you installed python, you have to get the current source code. You can either do this with [git](https://git-scm.com/) +by executing the following command in a directory of your choice: +``` +git clone https://github.com/sumeshir26/TimerX +``` +or press the green `Code` button on the [repository](https://www.github.com/sumeshir26/Timer) and then clicking `Download Zip` + +Then open a terminal in the directory of the source code and execute the following commands: +``` +python3 -m pip install -r requirements.txt +python3 -m pip install -r windows-requirements.txt +``` + +Now you can just open a text editor of your choice and start coding! + +If you are done with the code. You can [fork the repository](https://github.com/sumeshir26/TimerX) and create a new branch. +Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/pulls) and someone will review it asap. + From 5657a0bbddc8c08cf7fcbe2144555c05859b8d02 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Sat, 8 Jan 2022 10:48:08 +0100 Subject: [PATCH 05/10] Link CONTRIBUTING.md in readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f4559632..2985160c 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,7 @@ - โœ”๏ธ Windows: Tested on Windows 7,10, and 11 - โ”Linux: Tested on Debian-based systems(Raspbian). Also tested on Ubuntu 20.14. Not tested on Red Hat-based systems(Help Wanted) - โŒ MacOS: GitHub Actions build succeeds, but fails to work upon install. **Help wanted to debug.** + +# Contributing + +Read [this](./CONTRIBUTING.md) for instructions! From fe9997c35a7947c1962a1f5b0ed935428b72c6bf Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Sat, 8 Jan 2022 16:17:25 +0530 Subject: [PATCH 06/10] feat: Updated Contributing guide. --- CONTRIBUTING.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf51e7ab..633c1ce3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,37 @@ -# Contribute to TimerX +# Contributing to TimerX TimerX is written in **Python**, so you have to install it if you want to contribute. -You can download the latest version [here](https://www.python.org/downloads/release/python-3101/). -Make sure to check `Add python 3.10 to path` when installing it. - -When you installed python, you have to get the current source code. You can either do this with [git](https://git-scm.com/) -by executing the following command in a directory of your choice: -``` -git clone https://github.com/sumeshir26/TimerX -``` -or press the green `Code` button on the [repository](https://www.github.com/sumeshir26/Timer) and then clicking `Download Zip` - -Then open a terminal in the directory of the source code and execute the following commands: -``` +You can download the latest version from [here](https://www.python.org/downloads/). +Make sure to check `Add Python 3.10 to path` when installing it. +After installing Python, get [Git](https://git-scm.org). It's version control, so that will help you in adding your changes over here. +Click the `Fork` button on the top-right in the GitHub page. Give it a few seconds to fork TimerX and then execute these series of commands in your Terminal/Command Prompt. +```shell +git clone https://github.com/your-username/TimerX && cd TimerX python3 -m pip install -r requirements.txt python3 -m pip install -r windows-requirements.txt ``` +After following the series of commands, open your favourite text editor. We recommend that you use [Visual Studio Code](https://code.visualstudio.com). Make your changes and before committing, go to the status bar. There will be a place showing branches and the text `master`. Click that, click `New branch` and name your branch, such as `patch-1` or so. Make sure it correlates to your feature, if it's a patch, name it as a patch, if it's a feature, name the feature. Next, go to the Version Control tab from the sidebar and commit the file, _semantically_. We recommend you to use semantic commits since that is more concise. +Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/pulls) and someone will review it ASAP. -Now you can just open a text editor of your choice and start coding! - -If you are done with the code. You can [fork the repository](https://github.com/sumeshir26/TimerX) and create a new branch. -Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/pulls) and someone will review it asap. +### Gitpod - Ready to code +We support Gitpod - a ready-to-code environment customised for TimerX. You could either customise the app or the TimerX website. To code on Gitpod, follow the steps below: +#### 1. Click the link +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#/https://github.com/sumeshir26/TimerX) +#### 2. Log in with GitHub +The link will open a tab where you'll be asked to log in - it won't if you have already logged into Gitpod. +#### 3. Wait for the environment to load +The environment is building itself. You'll have to wait for at least 2 minutes, plus or minus. +#### 4. Start coding! +When Gitpod loads, you will be greeted by a VS Code UI. You could start coding immediately. But be wary - the commits are forced to be semantic. Fortunately, we have a CLI tool called `cz` that could help you on committing. +#### Ready to commit? +First, create a new branch. Name it in a way that it tells your feature in a short, abstract way. After creating your branch, open a new terminal(Ctrl + `. The ` symbol is beside the number 1 key or right above the Tab key. Then, type these commands: +```shell +git add . # stages your code to commit. +cz c # The tool for committing the code +``` +It will ask you what type of change it is, the scope(just hit enter) and the commit title. Make sure the title is apt and short(~50 words). Then, add a commit description if you want and choose N for breaking change(although if it's a breaking change, choose yes). Then, go ahead with enters and type this in the end: +```shell +git push +``` +After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls) and a reviewer will review it soon. From 3d629bd76719ef0e60168bd09a747d1505bab238 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Sat, 8 Jan 2022 16:20:22 +0530 Subject: [PATCH 07/10] fix: Remove the `.` from contrib guide link A URL redirects, so a `.` might make it hard. Great work @not-nef though, you made the refactor and styling. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2985160c..968da7f6 100644 --- a/README.md +++ b/README.md @@ -50,4 +50,4 @@ # Contributing -Read [this](./CONTRIBUTING.md) for instructions! +Read [this](/CONTRIBUTING.md) for instructions! From 7f65e4c37ac92f3b52dbab667520bb0bfc468371 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Sat, 8 Jan 2022 17:02:26 +0530 Subject: [PATCH 08/10] docs: Replace Vercel with Netlify --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 968da7f6..26c6e1fc 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Gitpod - Vercel + Netlify Actions From 870581b08a6140645bc804de0992c19841f88973 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Sat, 8 Jan 2022 17:49:21 +0530 Subject: [PATCH 09/10] docs: Fix typo in contributing.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 633c1ce3..edfb5277 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ First, create a new branch. Name it in a way that it tells your feature in a sho git add . # stages your code to commit. cz c # The tool for committing the code ``` -It will ask you what type of change it is, the scope(just hit enter) and the commit title. Make sure the title is apt and short(~50 words). Then, add a commit description if you want and choose N for breaking change(although if it's a breaking change, choose yes). Then, go ahead with enters and type this in the end: +It will ask you what type of change it is, the scope(just hit enter) and the commit title. Make sure the title is apt and short(~50 letters). Then, add a commit description if you want and choose N for breaking change(although if it's a breaking change, choose yes). Then, go ahead with enters and type this in the end: ```shell git push ``` From 3ad1eb1bf912a17d48fca44902984b6d73896991 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Sat, 8 Jan 2022 14:17:47 +0100 Subject: [PATCH 10/10] Fix netlify badge leading to vercel.com --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 26c6e1fc..3bd3a2d2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Gitpod - + Netlify