Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

50 lines (41 loc) · 2.6 KB

#Contributing to Cryptocat

##Coding style for contributions Please be mindful that you are contributing to security and encryption software. We expect all code to be pre-reviewed for security and to be of high quality.

All contributed code, written in JavaScript, must adhere to the following coding style:
1. Tabs are used for indentation, not spaces.
2. Lines are not ended with semicolons.
3. Use camel case for variables, filenames, and so on.
4. As a rule, use single quotes, (such as 'string'), not double quotes ("string").
5. As a rule, strict-type isEqual is preferred (1 === 1 instead of 1 == 1).
6. Please comment your code sufficiently.
7. Anonymous closures should be used wherever they are useful.
8. Brackets are not on new lines.
9. Strict mode must be enforced at all times.

##Contributing or improving translations Please do not send pull requests for translations. Instead, use Transifex. Notify a project manager for Cryptocat on Transifex in case you need assistance.
Note: In translations, please do not:

  • Insert newlines in strings you are translating.
  • Translate wildcard strings such as (NICKNAME) or (SIZE). Leave those as they are.

##Tests

  • Run tests using make tests.
  • Make sure your code conforms by running make lint.

##License All contributed code will automatically be licensed under the GNU Affero General Public License (AGPL3).
The full license text is included in LICENSE.txt.

##Discussion & Blog

##Contributors

  • Arlo Breault: OTR library maintainer, bug reporter, all-around helper.
  • Dmitry Chestnykh: Salsa20 CSPRNG implementation.
  • David Dahl: window.crypto.getRandomValues() implementation for Firefox.
  • Daniel "koolfy" Faucon: Documentation maintainer, bug reporter.
  • Andreas "Gordin" Guth: StropheJS maintainer, WebSocket & anonymous auth implementation.
  • Frederic Jacobs: Substantial contributions to Cryptocat for Mac.
  • Nadim Kobeissi: Lead developer. Created Cryptocat.

###Multimedia

  • Ingrid Burrington: Some icons and graphics.
  • A.J. Korkidakis: Promotional video.
  • P.J. Onori: Some of the icons.
  • Rich Vreeland: Audio notifications.

With warm thanks to a contributor who has asked to remain anonymous.