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 and click Join this project 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 3-Clause, 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/en.json. The translation system, Transifex, will automatically detect the change.

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

npm run translations will fail and error unless the following environment variables are set:

TRANSIFEX_TOKEN - Your API Token
TRANSIFEX_ORG - The organization your project is a part of
TRANSIFEX_PROJECT - The project name
TRNSIFEX_RESOURCE - The resource name (usually 'application')

Depending on your system, you can likely set them via the cli with a command like:

$ export TRANSIFEX_PROJECT=prose

Submitting Pull Requests

All pull requests should be proposed to the master branch. Pull requests should ideally include unit tests that confirm a bug or new feature. Prose uses the mocha testing framework along with chai and sinon.

Deploying

Github Actions is set up to deploy the master branch to github pages. All changes merged into master will automatically trigger a build/deploy job.

Building / Installing

Prose uses Browserify with Gulp to manage dependencies and build.

Prerequisites

• node.js.

Install steps

1. git clone [email protected]:prose/prose.git && cd prose/
2. Run npm i
3. To run prose with authentication locally, a oauth.json file is required in the root directory. npm will handle this for you with the gulp postinstall script.
4. Run npm start By default, prose will be set up on http:https://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:https://prose.io/?code=36f237f41bd81c1a3661. The code param represents the auth string. You can manually set the URL back to your prose instance.

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

Back to
http:https://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 npm run build to package code into a minified prose.min.js and see changes.

ProTip: You may want to run npm run start to serve the site and allow the running of gulp on every change.

Testing

Running npm test will run all unit tests as well as ensure that all translations used in the app are available in translations/en.json.

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

Notes on debugging

If Chrome DevTools' console reports an error and then points to an unrelated source location, the source map system might be getting confused. If you're working with an unminified prose.js, you can simply disable source maps.

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.