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
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,23 +47,21 @@ Head over to the [Browsersync Website Repo](https://github.com/BrowserSync/brows
47
47
48
48
## <aname="pull"></a> Submitting a Pull Request
49
49
Pull requests should be branched off the main Master branch. (There's no guarantee that what lives on the develop
50
-
branch will ever make it back to master, I do a **lot** of experimentation)
50
+
branch will ever make it back to master, I do a **lot** of experimentation).
51
51
52
-
## <aname="rules"></a> Coding Rules
53
-
To ensure consistency throughout the source code, keep these rules in mind as you are working:
52
+
Note: If your first PR is merged, you'll get write access to all Browsersync repos.
54
53
55
-
* All features or bug fixes **must be tested** by one or more [specs](https://github.com/BrowserSync/browser-sync/tree/master/test/specs).
56
-
* Don't be put off by this, I'm more than happy to help you implement tests - so don't be shy! I'd much rather spend time helping
57
-
you to provide tests than risk losing you as a contributor :)
58
-
* Follow the code style (Builds will fail if you don't, check at any time with `npm test`). Also, this project has a [.editorconfig](.editorconfig) file to help with code style; go to [EditorConfig.org](http://editorconfig.org) and download the plugin for your IDE.
59
-
* Don't introduce any extra 3rd party libraries unless you're creating a brand new feature that requires it.
60
-
* Don't fight async! Avoid promises or any other similar types of abstraction, Browsersync loves simple
61
-
callbacks and events.
62
-
* Keep your code simple and readable. If I can't tell what it's doing at first glance, it's too complex.
63
-
* Improve my code. Browsersync has a lot of moving parts and I don't pretend to be skilled in any particular area.
64
-
If *you* have particular experience though, then feel free to rip my code apart and tell me a better way to do something - I'll be
65
-
extremely grateful (as will the growing number of users!).
54
+
## <aname="rules"></a> Coding Advice
55
+
To ensure consistency throughout the source code, keep these rules in mind as you are working.
66
56
57
+
* If you're not sure how to provide tests for a feature or bug fix, you should still submit it and we'll help you complete the PR in one of the following ways:
58
+
* we can advise you how to go about it
59
+
* we can write the test, and then explain them to you.
60
+
* This project has a [.editorconfig](.editorconfig) file to help with code style; go to [EditorConfig.org](http://editorconfig.org) and download the plugin for your IDE.
61
+
* Don't introduce any extra 3rd party libraries unless you're creating a brand new feature that requires it.
62
+
* Try to keep your code simple and readable.
63
+
* Improve my code! Browsersync has a lot of moving parts and I don't pretend to be skilled in any particular area.
64
+
If *you* have particular experience though, then feel free to rip my code apart and tell me a better way to do something - I'll be extremely grateful (as will the growing number of users!).
67
65
68
66
## <aname="thanks"></a> Thank you!
69
67
If you contribute to Browsersync, or any other Open Source project, you're awesome! This project has been vastly improved
0 commit comments