Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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`
Expand Down
14 changes: 7 additions & 7 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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)
Expand Down Expand Up @@ -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/