CONTRIBUTING.md

Contributing to prose

Thanks for thinking of contributing to prose! Whether you are here to report issues or develop on the project the sections below provide outlines on how to get started.

Reporting Issues

Here's a quick list of things to consider before submitting an issue:

• Please search for your issue before filing it: many bugs and improvements have already been reported
• Write specifically what browser this is reported to be found in
• Write out the steps to replicate the error: when did it happen? What did you expect to happen? What happened instead?
• Please keep bug reports professional and straightforward: trust us, we share your dismay of software breaking.
• For bonus points, enable web developer extensions and report the Javascript error message.

And when in doubt, be over-descriptive of the bug and how you discovered it.

Translating

Translations are managed using the Transifex platform. After signing up, you can go to the prose project page, select a language and click Translate now to start translating.

Words in brackets, for example {name}, should not be translated into a new language: it's replaced with a place name when prose presents the text. So a French translation of "Uploading {file}" would look like "Réviser {file}".

The translations for presets consist of the names of presets, labels for preset fields, and lists of search terms. You do not need to translate the search terms literally -- use a set of synonyms and related terms appropriate to the target language, separated by commas.

Translations are licensed under BSD, the same license as prose.

prose translation project on Transifex

Adding New Strings for Translation

Prose translates strings with a t function - t('foo.bar') translate the key foo.bar into the current language. If you introduce new translatable strings to prose, only display them in the interface through the t() function.

Then, add the new string to translations/application.yaml. The translation system, Transiflex, will automatically detect the change.

Use make to build the translations with the local changes. make translate can be used to pull the latest translations from Transifex.

If you run make translate you will be warned to include a transifex.auth file in the root directory that contains your transifex user details:

{ "user": "username", "pass": "password" }

Submitting Pull Requests

All pull requests should be proposed to the master branch. The gh-pages branch manages rebuilds to the server. All pull requests should include an update to the version in package.json according to semver.

Deploying

1. git checkout master && git pull
2. git checkout gh-pages && git pull
3. git merge master
4. npm install
5. make clean && make
6. git add dist/
7. git commit
8. git push
9. git checkout master
10. Tag the release in master using git tag according to semver in the format vX.Y.Z. This should match the version in package.json.
11. Push tag to GitHub using git push --tags

Building / Installing

prose uses Browserify with Make to manage dependencies and build. Development also requires you have node.js >= v0.8 installed.

Prerequisites

• node.js.

Install steps

1. git clone [email protected]:prose/prose.git && cd prose/
2. Run make install
3. To run prose with authentication locally, a oauth.json file is required in the root directory. When you run make this file is created automatically.
4. npm install serve -g
5. Run serve By default, prose will be set up on http://localhost:3000.

Note: You should not commit the oauth.json file to a remote repo or along with a pull request.

Note: When you authorize the application the public gatekeeper will redirect to prose.io with a path that looks something like http://prose.io/?code=36f237f41bd81c1a3661. The code param represents the auth string. You can manually set the URL back to your prose instance.

Change
http://prose.io/?code=36f237f41bd81c1a3661

Back to
http://localhost:3000/?code=36f237f41bd81c1a3661

Alternatively you can setup your own Gatekeeper instance. For any changes you make to the codebase, you'll need to run make to package code into a minified prose.min.js and see changes.

ProTip: You may want to install watch so you can run watch make without needing to execute make on every change.

Testing

Running make will also build the browser tests available at http://localhost:8000/test

You can run tests quickly from the command line with npm test

Create tests in the test/spec/ directory. If possible try to mirror the app directory structure. Require any new test files in test/index.js

Code Style

Javascript

We use the Airbnb style for Javascript with a few differences:

No aligned =, no aligned arguments, spaces are either indents or the 1 space between expressions. No hard tabs, ever. Javascript code should pass through JSHint with no warnings.

CSS & Markup

• Single Quotes
• 2 spaces soft tabs

for CSS, use classes to target elements.