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

Readme Overhaul #39

Merged
merged 13 commits into from
Jan 9, 2022
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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 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.

### 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(<kbd>Ctrl</kbd> + <kbd>`</kbd>. The <kbd>`</kbd> 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 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
```
After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls) and a reviewer will review it soon.
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
<div align=center>

| 📢 Version 0.9 is Out! Get it [here](https://github.com/sumeshir26/TimerX/releases)! 🎉
| ---

<img src="./assets/readme/banner_new.png"></img>
</div>
<p align="center">
<img alt="TimerX Logo" src="./assets/logo_new.png" width="100px" />
<h1 align="center">TimerX</h1>
</p>

# <img alt="TimerX icon" width="32px" src="https://raw.githubusercontent.com/sumeshir26/TimerX/master/assets/logo_new.png"> TimerX
<p align="center">
<a style="text-decoration:none" href="https://github.com/sumeshir26/TimerX/releases">
<img src="https://img.shields.io/github/release/sumeshir26/TimerX.svg?style=flat-square" alt="Releases" width="117px" />
</a>
<a style="text-decoration:none" href="https://python.org">
<img src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" alt="Python" />
</a>
<a style="text-decoration:none" href="https://gitpod.io">
<img src="https://img.shields.io/badge/gitpod-f06611.svg?style=for-the-badge&logo=gitpod&logoColor=white" alt="Gitpod" />
</a>
<a style="text-decoration:none" href="https://www.netlify.com">
<img src="https://img.shields.io/badge/netlify-%23000000.svg?style=for-the-badge&logo=netlify&logoColor=#00C7B7" alt="Netlify" />
</a>
<a style="text-decoration:none" href="https://github.com/sumeshir26/TimerX/actions">
<img src="https://img.shields.io/badge/githubactions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white" alt="Actions" />
</a>
<a style="text-decoration:none" href="https://repl.it">
<img src="https://img.shields.io/badge/Repl.it-%230D101E.svg?style=for-the-badge&logo=replit&logoColor=white" alt="Repl.it" />
</a>
</p>

### 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)

Expand All @@ -31,3 +47,7 @@
- ✔️ Windows: Tested on Windows 7,10, and 11
- ❔Linux: Tested on Debian-based systems(Raspbian<!-- and ZorinOS-->). 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!