Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 1.99 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). 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.

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.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Getting started

git clone https://github.com/google/wireit.git
cd wireit
npm ci
npm run build

Running tests

npm test
npm test watch

Testing environment variables:

  • TEST_TIMEOUT: Default millisecond timeout for test cases.
  • SHOW_TEST_OUTPUT: Set to show all stdout and stderr from spawned wireit invocations in test cases.

Self-hosting version

Wireit is self-hosting: it is built and tested with itself. However, we don't want to build and test with the exact same code we are editing during development, because if we break something, we might be unable to build or test at all, or we might build or test incorrectly (e.g. we might think tests passed when actually the tests didn't even run).

For this reason, we depend on the latest published version in our devDependencies, instead of running directly against source. To update this version, run:

npm upgrade wireit