Skip to content

Commit

Permalink
Issue #811. Document what building does for what and when.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Taylor committed Dec 22, 2015
1 parent f420e8b commit d2c50c6
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You are welcome to contribute to this project. Here are the guidelines we try to
* [Installing Grunt](#installing-grunt)
* [Configuring The Server](#configuring-the-server)
* [Starting The Server](#starting-the-server)
* [Building Project](#building-project)
* [Building the Project](#building-the-project)
* [Coding](#coding)
* [Running Tests](#running-tests)
* [Functional Tests](#functional-tests)
Expand Down Expand Up @@ -333,7 +333,14 @@ make start
You should now have a local instance of the site running at `http://localhost:5000/`. Please [file bugs](https://github.com/webcompat/webcompat.com/issues/new) if something went wrong!
### Building Project
### Building the Project
You need to build the project before serving it from a webserver will work, and after certain kinds of changes are made.
* CSS: a build will run cssnext, combine custom media queries, and concat all source files into webcompat.dev.css. You'll need to re-build the CSS to see any changes, so it's recommended to use a watch task (see `make watch` or `grunt watch`).
* JS: a build will run eslint, minify and concat source files.
* HTML templates: the changes should be served from disk without the need for rebuilding
* Python: the Flask local server will detect changes and restart automatically. No need to re-build.
You can build the entire project (CSS and JavaScript files and optimize images) by executing this command on Mac/Linux:
Expand Down

0 comments on commit d2c50c6

Please sign in to comment.