From 54232d2a9d854673c5a06c35f672df58bd91d45b Mon Sep 17 00:00:00 2001 From: Om Thakare Date: Mon, 10 Oct 2022 20:53:35 +0530 Subject: Added CONTRIBUTING.md (#23) * created contribution.md * Created contribution.md * Update README.md * Created Contributing.md --- CONTRIBUTING.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 5 ++++ 2 files changed, 97 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5753e2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ + +# How Watcher works ? + +First let's understand how it works. + +`./install` file install's all the py scripts and make Watcher to run on startup. + + +--------------------------- ## **v1.0** ## ---------------------------- + +- **[afk.py](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/afk.py)** : As name sugested it records the time for being afk it will count afk time when no input is given within 1 min . Also it ignores if their is video playback. + +- **[analysis.py](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/analysis.py)** : It gives the report for the week summary and day summary of the usage. +- **[commands.py](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/commands.py)** : This is used to display the data that analysis.py has analysed. Additionally, it contains all of the command outputs; in essence, this file is where the user interacts with the Wacther. + +- **[get_windows.py](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/get_windows.py)** : It gives the title/name of the Active Window/App. + +- **[time_operations.py](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/time_operations.py)** : It converts the raw time data into time how much the app is used. Also format produce the time in [HH:MM:SS](https://docs.oracle.com/cd/E41183_01/DR/Time_Formats.html) format. + +- **[watch.log](https://github.com/Waishnav/Watcher/blob/v1.0/src/Watcher/watch_log.py)** : This is where the logs file are created it creates two kind of log files for Week analysis and Day analysis, log files for Day analysis are created in [Date].csv format and for week W[week_no.]_[year].py format. + +----------------------------- ## **v2.0** ## -------------------------- + +#### Main Difference between [v1.0](https://github.com/Waishnav/Watcher/tree/v1.0/src/Watcher) and [v2.0](https://github.com/Waishnav/Watcher/tree/v2.0/src/Watcher) is the Represntation of the csv and the Algorithm( The way in which it calculate and present the usage time ) is **optimized**. + +- #### The file which is changed mainly is [analysis.py](https://github.com/Waishnav/Watcher/blob/v2.0/src/Watcher/analysis.py) and the [watch_log.py](https://github.com/Waishnav/Watcher/blob/v2.0/src/Watcher/watch_log.py). + +#### In v1.0 their is multiple session of time created even for the same window/apps but in v2.0 this is optimized and been removed the multiple session for each apps. +## Screenshots (csv files) +v1.0 | v2.0 +:-------------------------:|:-------------------------: +![](https://user-images.githubusercontent.com/83799380/194891764-f45c529c-d29d-4d14-96fc-bce0e80becb5.png) | ![](https://user-images.githubusercontent.com/83799380/194891867-a49df66a-5ae0-4b9b-9aa7-b6d6681c4574.png) + +----------------------- +How to Contribute +================= + +**Table of Contents** + + - [Getting started](https://github.com/Waishnav/Watcher) + - [How you can help](#how-you-can-help) + - [Questions?](#questions) + + +## How you can help + +There are many ways to contribute to Watcher: + + - Work on issues labeled [`good first issue`][good first issue] or [`help wanted`][help wanted], these are especially suited for new contributors. + - Fix [`bugs`][bugs]. + - Implement new features. + - Look among the [requested features][requested features] on the forum. + + - Write documentation. + + + + +## Commit message guidelines + +When writing commit messages try to follow [Conventional Commits](https://www.conventionalcommits.org/). It is not a strict requirement (to minimize overhead for new contributors) but it is encouraged. + +The format is: + +``` +[optional scope]: + +[optional body] + +[optional footer] +``` + +Where `type` can be one of: `feat, fix, chore, ci, docs, style, refactor, perf, test` + +Examples: + +``` + - feat: added ability to sort by duration + - fix: fixes incorrect week number (#407) + - docs: improved query documentation +``` + + +## Questions? + +If you have any questions, you can: + + - Post on [the forum][forum] or [GitHub Discussions][github discussions]. + - (as a last resort/if needed) Email one of the maintainers at: [waishnavdeore@gmail.com](mailto:waishnavdeore@gmail.com) + + +[github discussions]: https://github.com/Waishnav/Watcher/discussions. diff --git a/README.md b/README.md index 68d3cf7..a9310c5 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,10 @@ - [About](#about) - [Gallery](#gallery) - [Installation](#installation) +- [Contribution](#for-contributing) - [Todo](#to-do) + ## About Watcher is CLI-app (at this moment) which helps you to get perspective about your Screen-time @@ -45,6 +47,9 @@ $ cd ./Watcher/ $ chmod +x ./install && ./install ``` +### For Contributing +If you are interseted in contibuting checkout [CONTRIBUTING.md](https://github.com/Waishnav/Watcher/blob/main/CONTRIBUTING.md) + ## To-do - [x] AFK feature -- cgit v1.2.3