Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.52 KB

Contributing to the Convergence JavaScript Client

First, thanks for your interests in contributing to Convergence. We strive to build a strong and open community focused on making Convergence the best real time collaboration framework.

Here are some important resources:

Testing

Please help us out by writing tests, if possible for your new functionality. Make sure all current tests pass by running npm run test before committing.

Submitting changes

Please create a GitHub Pull Request with a clear list of what you've done (read more about pull requests).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We use TSLint to lint our code. you can run npm run lint to lint the code before submitting.

Thanks, Convergence Labs, Inc.