You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Summary: Updated the Changelog and also the Contributing guide (copied from Relay :) ). This is a big release!
public
Reviewed By: amasad, voideanvalue
Differential Revision: D2568010
fb-gh-sync-id: 79e1b82ea4a61f642c2eca62faa9c25618c2fbc6
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-18Lines changed: 22 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
1
# Contributing to Jest
2
2
3
-
Jest is one of Facebook's first open source projects that is both under very active development and is also being used to ship code to everybody on facebook.com. We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and preempts some questions you may have.
3
+
Jest is one of Facebook's open source projects that is both under very active development and is also being used to ship code to everybody on [facebook.com](https://www.facebook.com). We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.
4
+
5
+
## [Code of Conduct](https://code.facebook.com/codeofconduct)
6
+
7
+
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
4
8
5
9
## Our Development Process
6
10
@@ -17,46 +21,46 @@ The core team will be monitoring for pull requests. When we get one, we'll run s
17
21
*Before* submitting a pull request, please make sure the following is done…
18
22
19
23
1. Fork the repo and create your branch from `master`.
20
-
2. If you've added code that should be tested, add tests!
24
+
2. If you've added code that should be tested, add tests.
21
25
3. If you've changed APIs, update the documentation.
22
26
4. Ensure the test suite passes (`npm test`).
23
27
5. If you haven't already, complete the CLA.
24
28
25
-
### Contributor License Agreement ("CLA")
29
+
### Contributor License Agreement (CLA)
26
30
27
31
In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.
28
32
29
-
Complete your CLA here: <https://code.facebook.com/cla>
33
+
[Complete your CLA here.](https://code.facebook.com/cla)
30
34
31
-
## Bugs
35
+
###Bugs
32
36
33
37
### Where to Find Known Issues
34
38
35
-
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.
39
+
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
36
40
37
41
### Reporting New Issues
38
42
39
-
The best way to get your bug fixed is to provide a reduced test case. jsFiddle, jsBin, and other sites provide a way to give live examples.
43
+
The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.
40
44
41
45
### Security Bugs
42
46
43
-
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. With that in mind, please do not file public issues and go through the process outlined on that page.
47
+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page.
44
48
45
49
## How to Get in Touch
46
50
47
-
* IRC - [#jestjs on freenode](http://webchat.freenode.net/?channels=jestjs)
48
-
* Mailing list - [jestjs on Google Groups](http://groups.google.com/group/jestjs)
51
+
* Discord - [#jest](https://discordapp.com/channels/102860784329052160/103622435865104384) on [Reactiflux](http://www.reactiflux.com/)
49
52
50
-
##Coding Style
53
+
### Code Conventions
51
54
55
+
* 2 spaces for indentation (no tabs).
56
+
* 80 character line length strongly preferred.
57
+
* Prefer `'` over `"`.
58
+
* ES2015 syntax when possible.
59
+
*`'use strict';`.
60
+
* Use [Flow types](http://flowtype.org/).
52
61
* Use semicolons;
53
-
* Commas last,
54
-
* 2 spaces for indentation (no tabs)
55
-
* Prefer `'` over `"`
56
-
*`'use strict';`
57
-
* 80 character line length
58
-
* "Attractive"
59
-
* Do not use the optional parameters of `setTimeout` and `setInterval`
0 commit comments