Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.

Latest commit

 

History

History
94 lines (65 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

94 lines (65 loc) · 3.06 KB
Raw

How to Contribute

First of all, thank you for your interest in Rendertron! We'd love to accept your patches and contributions!

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Getting Code

  1. Clone this repository
git clone https://github.com/GoogleChrome/rendertron
cd rendertron
  1. Install dependencies
npm install
  1. Run tests locally. For more information about tests, read Running & Writing Tests.
npm test
  1. (Optional) when developing cache related stuff you will need npm run test-cache commands for tests.
    • This requires the Google Cloud SDK, follow the steps described here to install
    • run gcloud components install beta cloud-datastore-emulator
    • if you do not have Java 8+ JRE installed, you should install it too, as the Google Cloud Datastore emulator requires it

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Code Style

  • Coding style is fully defined in tslint.json
  • Comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory.

To run code linter, use:

npm run lint

Adding New Dependencies

For all dependencies (both installation and development):

  • Do not add a dependency if the desired functionality is easily implementable.
  • If adding a dependency, it should be well-maintained and trustworthy.

A barrier for introducing new installation dependencies is especially high:

  • Do not add installation dependency unless it's critical to project success.

Running & Writing Tests

  • Every feature should be accompanied by a test.

  • Tests should be hermetic. Tests should not depend on external services unless absolutely needed.

  • Tests should work on all three platforms: Mac, Linux and Windows.

  • To run all tests:

npm test