From 00910ec47bccf029fe900e6b01b89b958054a152 Mon Sep 17 00:00:00 2001 From: Matt Kangas Date: Tue, 12 May 2015 12:36:16 -0400 Subject: [PATCH 1/2] tweak dev.md --- docs/dev.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/dev.md b/docs/dev.md index 7facd9d9f50..769c875fca1 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -29,7 +29,7 @@ npm install - Install [nodejs][nodejs] and [mongodb][mongodb] - `git clone git@github.com:10gen/scout.git` -- `npm npm install` +- `npm install` - Start the server `npm start` ### I edited a `.jade` file. Now what? @@ -47,6 +47,8 @@ variables available to atom editor themes. `less/variables.less` maps the atom variables to bootstrap variables and a full list is available in [the patternlib][less-variables]. +> @todo: create patternlib + ### How do I add new features? > @todo: needs update @@ -66,12 +68,11 @@ is available in [the patternlib][less-variables]. ## Dev Dependencies There are a few dev dependencies that will be installed you might be -interested that make developing mongoscope a complete joy. +interested that make developing Scout a complete joy. ### Gulp -[Gulp][gulp] is a build tool like grunt or -broccoli, or Make and scons if you don't usually work with JS. Gulp is +[Gulp][gulp] is a build task automation tool. Gulp is different from other JS tools in that it is streams centric and just javascript. Unlike grunt, you don't have massive config objects you must conform to; it takes a code over configuration approach much like Make. @@ -80,8 +81,7 @@ If you're interested in learning more, ### Jade -[Jade][jade] is our templating language -of choice. Jade is great because: +[Jade][jade] is our templating language of choice. Jade is great because: - light enough to use on the client via browserify - robust enough to use on the server (e.g. support for layouts and blocks) @@ -220,6 +220,6 @@ Recommended user preferences, particularly `ensure_newline_at_eof_on_save`, [mongodb.js]: https://www.npmjs.org/browse/keyword/mongodb.js [browserify talk]: http://imlucas.github.io/talks/mongo_052014/static/index.html -[patternlib]: http://10gen.github.io/mongoscope/patternlib.html +[patternlib]: http://10gen.github.io/scout/patternlib.html [less-variables]: http://10gen.github.io/scout/patternlib.html#less-variables [gulp-intro]: http://julienrenaux.fr/2014/05/25/introduction-to-gulp-js-with-practical-examples/ From e33dece75bfe79dc844b89c99d9ad8bfb2b0bfb4 Mon Sep 17 00:00:00 2001 From: Matt Kangas Date: Tue, 12 May 2015 12:50:19 -0400 Subject: [PATCH 2/2] CONTRIBUTING nitcpicks --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a9abc044b2..f492e52a084 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Great to have you here. These are a few ways you can help make this project bett - add an example to README.md - avoid sending pull requests related to "style" or whitespace as we have tools in our workflow to do this already -- [creating a new issue](http://github.com/10gen/scout/issues) +- [create a new issue](http://github.com/10gen/scout/issues) if there is something you need this project to do that it currently doesn't. We're always more than happy to chat about other projects. @@ -16,7 +16,7 @@ More information to help you work on Scout is available in ## Workflow 1. Fork the repository on GitHub -1. Create a branch with a name that breifly describes your feature +1. Create a branch with a name that briefly describes your feature 1. Implement your feature or bug fix 1. Add new cases to `./tests.js` that verify your bug fix or make sure no one unintentionally breaks your feature in the future and run them with `npm test`