blob: fde88d28135b7e90ba8f03d065c61c96a74f2dbf [file] [log] [blame] [view]
alexeagle64cf46f2017-04-24 00:01:11 +02001Want to contribute? Great! First, read this page (including the small print at the end).
2
3### Before you contribute
TypeScript Team52b6fe62018-12-13 14:39:06 -08004
alexeagle64cf46f2017-04-24 00:01:11 +02005**Before we can use your code, you must sign the
6[Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
7(CLA)**, which you can do online.
8
9The CLA is necessary mainly because you own the copyright to your changes,
10even after your contribution becomes part of our codebase, so we need your
11permission to use and distribute your code. We also need to be sure of
12various other things for instance that you'll tell us if you know that
13your code infringes on other people's patents. You don't have to sign
14the CLA until after you've submitted your code for review and a member has
15approved it, but you must do it before we can put your code into our codebase.
16
17Before you start working on a larger contribution, you should get in touch
18with us first. Use the issue tracker to explain your idea so we can help and
19possibly guide you.
20
TypeScript Team52b6fe62018-12-13 14:39:06 -080021**Before starting a complex contribution we strongly encourage you to share a design document**.
22
23[Here](https://goo.gl/YCQttR) you can find a document template.
24
alexeagle64cf46f2017-04-24 00:01:11 +020025### Code reviews and other contributions.
TypeScript Team52b6fe62018-12-13 14:39:06 -080026
alexeagle64cf46f2017-04-24 00:01:11 +020027**All submissions, including submissions by project members, require review.**
TypeScript Team52b6fe62018-12-13 14:39:06 -080028We use GitHub's code review system to suggest changes, then merge the changes
29to master when the PR is green and reviewed. The changes will then be in the
30next release.
alexeagle64cf46f2017-04-24 00:01:11 +020031
32### The small print
TypeScript Team52b6fe62018-12-13 14:39:06 -080033
alexeagle64cf46f2017-04-24 00:01:11 +020034Contributions made by corporations are covered by a different agreement than
35the one above, the
36[Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).