From dc75f6fb0ec0aeedd238383a1a6096c0e33d4c4f Mon Sep 17 00:00:00 2001 From: ccd0 Date: Mon, 16 Nov 2015 23:13:47 -0800 Subject: [PATCH] Edit CONTRIBUTING.md: Add missing dependencies, recommend shallow clone, etc. --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04966e25a..ff084f37a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,9 @@ If you're reporting a bug, the more detail you can give, the better. If I can't ### Get started -- Install [node.js](http://nodejs.org/). +- Install [git](https://git-scm.com/), [node.js](https://nodejs.org/), and [npm](https://www.npmjs.com/). - Install [Grunt's CLI](http://gruntjs.com/): `npm install -g grunt-cli` -- Clone 4chan X: `git clone https://github.com/ccd0/4chan-x.git` +- Clone 4chan X: `git clone https://github.com/ccd0/4chan-x.git --depth 1` - Open the directory: `cd 4chan-x` - Install/Update 4chan X dependencies: `npm install` @@ -30,11 +30,14 @@ If you're reporting a bug, the more detail you can give, the better. If I can't ### Contribute -- Edit the sources (not the compiled scripts in the builds/ directory). -- Compile the script with `grunt`. +- 4chan X is written in [CoffeeScript](http://coffeescript.org/). If you're already familiar with Javascript, it doesn't take long to pick up. +- Edit the sources in the src/ directory (not the compiled scripts in builds/). +- Compile the script with: `grunt` - Install the compiled script (found in the testbuilds/ directory), and test your changes. +- Make sure you have set your name and email as you want them, as they will be published in your commit message:
`git config user.name yourname`
`git config user.email youremail` +- Commit your changes: `git commit -a` - Open a pull request by doing any of the following: - - Fork this repository on Github, push your changes to your fork, and make a pull request via Github's mechanism. + - Fork this repository on Github, push your changes to your fork, and make a pull request through the Github website. - Push your changes to any online Git repository, and [open an issue](https://gitreports.com/issue/ccd0/4chan-x) with an explanation of your changes and the URL, branch, and commit you want me to pull from. - Export your changes via `git bundle` (e.g. `git bundle create file.bundle master..your-branch`), and upload them to a file host like https://jii.moe/. Then [open an issue](https://gitreports.com/issue/ccd0/4chan-x) with an explanation of your changes and the URL of the file.