[irc/freenode/web-7.0.git] / CONTRIBUTE.md

## Dev Requirements:

* [Myth](http://www.myth.io/)
* [svgo](https://github.com/svg/svgo)
* [cms7](https://github.com/edk0/cms7)

## Building

Install `myth` and `svgo` globally by running `npm install -g myth svgo`.

Python 3 is needed for `cms7` to work. Make a virtualenv with `pyvenv env`,
then run `pip install -r requirements.txt` to install `cms7`.

With dependencies installed, just run `cms7` to build. The output files are in
the `out/` folder. You can run `python -m http.server` in the `out/` folder to
serve the compiled files, and go to `http://localhost:8000` to see the files.

## Git

`master` is automatically deployed to https://freenode.github.io/web-7.0/. It
is also configured to reject commits that haven't had a build succeed in a
branch or pull request; make one and ideally get someone else to confirm.

Branches are cheap; use one per feature.

Changes should be tested on both big and small screens.
Commit	Line	Data
b854cfc3 SB	1	## Dev Requirements:
	2
	3	* [Myth](http://www.myth.io/)
0bd7525f	4	* [svgo](https://github.com/svg/svgo)
b854cfc3 SB	5	* [cms7](https://github.com/edk0/cms7)
b854cfc3 SB	6
0bd7525f EK	7	## Building
0bd7525f EK	8
eacb4ce6	9	Install `myth` and `svgo` globally by running `npm install -g myth svgo`.
070e5344	10
eacb4ce6 EV	11	Python 3 is needed for `cms7` to work. Make a virtualenv with `pyvenv env`,
	12	then run `pip install -r requirements.txt` to install `cms7`.
	13
	14	With dependencies installed, just run `cms7` to build. The output files are in
	15	the `out/` folder. You can run `python -m http.server` in the `out/` folder to
	16	serve the compiled files, and go to `http://localhost:8000` to see the files.
b854cfc3	17
0bd7525f	18	## Git
b854cfc3	19
0bd7525f EK	20	`master` is automatically deployed to https://freenode.github.io/web-7.0/. It
	21	is also configured to reject commits that haven't had a build succeed in a
	22	branch or pull request; make one and ideally get someone else to confirm.
b854cfc3	23
0bd7525f	24	Branches are cheap; use one per feature.
b854cfc3	25
0bd7525f	26	Changes should be tested on both big and small screens.