From 488b3f163611b9615181107d5157e5809e889731 Mon Sep 17 00:00:00 2001 From: Cassidy Williams Date: Mon, 15 May 2017 11:10:50 -0700 Subject: [PATCH] Add contributing guidelines, reformat dev section --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5c26544..2cf9af8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,37 @@ [todometer](http://cassidoo.github.io/todometer) ========= -A meter-based to-do list built with Electron, React, Redux, and LESS. +A simple meter-based to-do list built with Electron, React, Redux, and LESS. ![todometer](assets/screenshot.png) +### 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 keep todometer simple? + - Does it break anything? + - Does it stick to the original goal of todometer (a _simple_, meter-based to-do list) + - 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! + ### Development -* Clone the repo via `git clone https://github.com/cassidoo/todometer.git` -* Go to the project directory and install dependencies: `cd todometer && npm install` -* Start developing by `npm start`. This will show an electron window with your application's build. \ No newline at end of file +- Clone the repo: +``` +git clone https://github.com/cassidoo/todometer.git +``` + +- Go to the project directory and install dependencies: +``` +cd todometer && npm install +``` + +- Run `npm start` to show the Electron application window with your current build.