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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-2
Original file line number
Diff line number
Diff line change
@@ -35,15 +35,20 @@ Submitting Pull Requests
35
35
36
36
Instructions are similar to those for bug reports. Please provide the following information:
37
37
38
+
* If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**.
38
39
* Use a **clear and descriptive title** for the pull request.
39
-
* Provide a **description of the suggested changes** in as many details as necessary.
40
+
* Provide a **description of the changes** in as many details as necessary.
40
41
***Document your new code** where necessary.
41
42
* Please **refrain from refactoring (unrelated code)** as it makes your pull request easier to review.
42
43
***Create tests for your new code** where necessary. For creating or updating tests, please see the [Test Instructions](./tests).
43
44
44
-
Before submitting your pull request, please make sure that the following conditions are met:
45
+
Before submitting your pull request, also make sure that the following conditions are met:
45
46
46
47
* Your new code **adheres to the code style** through running `npm run check`.
47
48
* Your new code **passes all existing and new tests** through running `npm run test`.
48
49
* Your PR **excludes distribution files** in `dist/**`.
49
50
* You appended yourself to the **list of contributors** in the [NOTICE](./NOTICE) file.
51
+
52
+
Please note that if a pull request is rather complicated, i.e. touches lots of internals, or became stale, it is not uncommon that a core contributor performs the final integration to get it done in good conscience while naming you as a co-author.
0 commit comments