Skip to content

i Added contribution.txt with an improvement idea #144

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

i Added contribution.txt with an improvement idea #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fc8ddfc
Added contribution.txt with an improvement idea
Abhi-git-dev1 Mar 26, 2025
943f6a1
Added .gitignore and updated README.md
Abhi-git-dev1 Mar 26, 2025
dcb491a
Updated description in conflict-demo branch
Abhi-git-dev1 Mar 26, 2025
7b34b00
Updated README.md in conflict-demo branch
Abhi-git-dev1 Mar 26, 2025
9305900
Updated README.md in main branch
Abhi-git-dev1 Mar 26, 2025
dcc386a
Resolved merge conflict in README.md
Abhi-git-dev1 Mar 26, 2025
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
27 changes: 2 additions & 25 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,2 @@
# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build
dist

# cache
.electron-vendors.cache.json

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
*.log
temp/
54 changes: 1 addition & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,3 @@
# todometer

A simple, meter-based to-do list built with Electron and React.
This is an update from conflict-demo branch

![todometer](assets/screenshot.png)

## Download

Nab the latest version from the [Releases](https://github.com/cassidoo/todometer/releases) page!

## Development

- Clone the repo:

```bash
$ git clone https://github.com/cassidoo/todometer.git
```

- Go to the project directory and install dependencies:

```bash
$ cd todometer && npm install
```

To show the Electron application window with your current build:

```bash
$ npm run dev
```

To build a production version:

```bash
$ npm install
$ npm run postinstall
$ npm run pre-electron-pack
$ npm run electron-pack
```

## Contributing

So you want to contribute? Yay! Great! Fun!
I love seeing new PRs for todometer. That being said, not every pull request will be merged. The general guidelines I'll follow are:

- Does it make developing todometer easier?
- Does it help other platforms (Windows, Mac, Linux) work better?
- Does it fix a bug?
- Does it break anything?
- Does it stick to the original goal of todometer (a _simple_, meter-based to-do list)
- Does it reduce the build size?
- Is it necessary?

Regarding that last point, I don't expect all pull requests to be absolutely necessary. New features are good. That being said, if the new features make the app unnecessarily complex in some way without bringing value to the users, it won't be merged.

Please don't be hurt if your PR isn't merged. You're lovely for working on it. If you are thinking about working on something, feel free to make an issue beforehand so that you can make sure it'll be worth your time!
1 change: 1 addition & 0 deletions contribution.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Your Name - Your Improvement Idea