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
@@ -76,26 +76,90 @@ fits with the scope and aims of the project. It's up to *you* to make a strong
76
76
case to convince the project's developers of the merits of this feature. Please
77
77
provide as much detail and context as possible.
78
78
79
-
## Pull Request Guidelines
80
79
81
-
You must understand that by contributing code to this project, you are granting
82
-
the authors (and/or leaders) of the project a non-exclusive license to
83
-
re-distribute your code under the current license and possibly re-license the
84
-
code as deemed necessary.
80
+
## Pull Requests
85
81
86
-
* To instantiate a context or use it, use the variable **that** instead of
87
-
**_this**.
88
-
* Please check to make sure that there aren't existing pull requests attempting
89
-
to address the issue mentioned. We also recommend checking for issues related
90
-
to the issue on the tracker, as a team member may be working on the issue in
91
-
a branch or fork.
92
-
* Non-trivial changes should be discussed in an issue first
93
-
* If your change affects the distributed files, re-generate them using the
94
-
[gulp procedure](#using-gulp)
95
-
* If possible, add relevant tests to cover the change
96
-
* Write a convincing description of your PR and why we should land it
82
+
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
97
83
98
-
## Using Gulp
84
+
Good pull requests - patches, improvements, new features - are a fantastic
85
+
help. They should remain focused in scope and avoid containing unrelated
86
+
commits.
87
+
88
+
**Please ask first** before embarking on any significant pull request (e.g.
89
+
implementing features, refactoring code, porting to a different language),
90
+
otherwise you risk spending a lot of time working on something that the
91
+
project's developers might not want to merge into the project.
92
+
93
+
Please adhere to the coding conventions used throughout a project (indentation,
94
+
accurate comments, etc.) and any other requirements (such as test coverage).
95
+
96
+
Follow this process if you'd like your work considered for inclusion in the
97
+
project:
98
+
99
+
1.[Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
100
+
and configure the remotes:
101
+
102
+
```bash
103
+
# Clone your fork of the repo into the current directory
feature to tidy up your commits before making them public.
130
+
131
+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
132
+
133
+
```bash
134
+
git pull [--rebase] upstream <dev-branch>
135
+
```
136
+
137
+
6. Push your topic branch up to your fork:
138
+
139
+
```bash
140
+
git push origin <topic-branch-name>
141
+
```
142
+
143
+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
144
+
with a clear title and description.
145
+
146
+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
147
+
license your work under the same license as that used by the project.
148
+
149
+
150
+
## Code Consitency
151
+
152
+
To help create consistent looking code throughout the project, we use a few tools to help us.
153
+
154
+
#### ESlint
155
+
We use [ESlint](http://eslint.org) on each build to find easy-to-catch errors and potential problems in our js. You can find our ESlint settings in the `.eslintrc.yml` file in the root of the project.
156
+
157
+
#### EditorConfig
158
+
159
+
We use [EditorConfig](http://EditorConfig.org) to maintain consistent coding styles between various editors and IDEs. You can find our settings in the `.editorconfig` file in the root of the project.
160
+
161
+
162
+
## Development
99
163
100
164
We are using node, gulp and babel to build and (in the future) test this project. This means that you must setup a local development environment:
101
165
@@ -110,7 +174,7 @@ We are using node, gulp and babel to build and (in the future) test this project
110
174
-`gulp serve` Start server with Browsersync.
111
175
-`gulp clean` Clean output directories.
112
176
-`gulp bundler` Bundle javasript modules.
113
-
-`gulp scripts` Concatenate and minify JavaScript.
177
+
-`gulp scripts` Concatenate and minify JavaScript to `dist`.
114
178
-`gulp lint:es` Lint ES6 files using eslint.
115
179
-`gulp lint:js` Lint Javascript files using jshint.
116
180
-`gulp clean` Clean out distribution javascript files.
0 commit comments