|
| 1 | +# Instructions for Logging Issues |
| 2 | + |
| 3 | +## 1. Read the FAQ |
| 4 | + |
| 5 | +Please [read the FAQ](https://github.com/Microsoft/TypeScript/wiki/FAQ) before logging new issues, even if you think you have found a bug. |
| 6 | + |
| 7 | +Issues that ask questions answered in the FAQ will be closed without elaboration. |
| 8 | + |
| 9 | +## 2. Search for Duplicates |
| 10 | + |
| 11 | +[Search the existing issues](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93&q=is%3Aissue) before logging a new one. |
| 12 | + |
| 13 | +## 3. Do you have a question? |
| 14 | + |
| 15 | +The issue tracker is for **issues**, in other words, bugs and suggestions. |
| 16 | +If you have a *question*, please use [http://stackoverflow.com/questions/tagged/typescript](Stack Overflow), [https://gitter.im/Microsoft/TypeScript](Gitter), your favorite search engine, or other resources. |
| 17 | +Due to increased traffic, we can no longer answer questions in the issue tracker. |
| 18 | + |
| 19 | +## 4. Did you find a bug? |
| 20 | + |
| 21 | +When logging a bug, please be sure to include the following: |
| 22 | + * What version of TypeScript you're using (run `tsc --v`) |
| 23 | + * If at all possible, an *isolated* way to reproduce the behavior |
| 24 | + * The behavior you expect to see, and the actual behavior |
| 25 | + |
| 26 | +You can try out the nightly build of TypeScript (`npm install typescript@next`) to see if the bug has already been fixed. |
| 27 | + |
| 28 | +## 5. Do you have a suggestion? |
| 29 | + |
| 30 | +We also accept suggestions in the issue tracker. |
| 31 | +Be sure to [check the FAQ](https://github.com/Microsoft/TypeScript/wiki/FAQ) and [search](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93&q=is%3Aissue) first. |
| 32 | + |
| 33 | +In general, things we find useful when reviewing suggestins are: |
| 34 | +* A description of the problem you're trying to solve |
| 35 | +* An overview of the suggested solution |
| 36 | +* Examples of how the suggestion would work in various places |
| 37 | + * Code examples showing e.g. "this would be an error, this wouldn't" |
| 38 | + * Code examples showing the generated JavaScript (if applicable) |
| 39 | +* If relevant, precedent in other languages can be useful for establishing context and expected behavior |
| 40 | + |
| 41 | +# Instructions for Contributing Code |
| 42 | + |
1 | 43 | ## Contributing bug fixes
|
2 | 44 |
|
3 | 45 | TypeScript is currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved ("Milestone == Community") by the TypeScript team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.
|
|
0 commit comments