Goyslop/4chan-x
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Edit CONTRIBUTING.md: Add missing dependencies, recommend shallow clone, etc.

Browse Source
This commit is contained in:
ccd0 2015-11-16 23:13:47 -08:00
parent 98170d9a0f
commit dc75f6fb0e
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -17,9 +17,9 @@ If you're reporting a bug, the more detail you can give, the better. If I can't
### Get started ### 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` - 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` - Open the directory: `cd 4chan-x`
- Install/Update 4chan X dependencies: `npm install` - 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 ### Contribute
- Edit the sources (not the compiled scripts in the builds/ directory). - 4chan X is written in [CoffeeScript](http://coffeescript.org/). If you're already familiar with Javascript, it doesn't take long to pick up.
- Compile the script with `grunt`. - 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. - 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:<br>`git config user.name yourname`<br>`git config user.email youremail`
- Commit your changes: `git commit -a`
- Open a pull request by doing any of the following: - 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. - 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. - 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.