@@ -9,16 +9,27 @@ This will save time for everyone._
9
9
If you don't understand what a * pull request* is, or how to submit one, please refer to the [ help documentation] [ ]
10
10
provided by GitHub.
11
11
12
+ ## Is It Really a Support Issue
13
+
14
+ If you aren't sure if your contribution is needed or necessary, please visit the [ support forum] [ ml-users ] before attempting to
15
+ submit a pull request or a ticket.
16
+
17
+ ## Search Project Bug Base
18
+
19
+ We require every commit, bug or enhancement to be tracked via our [ bug database] [ ] . It is useful, before you get too
20
+ far, that you have checked that your issue isn't already known, otherwise addressed? If you think it is a valid defect or
21
+ enhancement, please open a new ticket before submitting your pull request.
22
+
12
23
## Discuss Non-Trivial Contributions with the Committers
13
24
14
25
If your desired contribution is more than a non-trivial fix, you should discuss it on the
15
- [ contributor's mailing list] [ dojo-contrib ] . If you currently are not a member, you can request to be added.
26
+ [ contributor's mailing list] [ ml-dev ] . If you currently are not a member, you can request to be added.
16
27
17
28
## Contributor License Agreement
18
29
19
30
We require all contributions, to be covered under the Dojo Foundation's [ Contributor License Agreement] [ cla ] . This can
20
31
be done electronically and essentially ensures that you are making it clear that your contributions are your
21
- contributions, you have the legal right to contribute and you are transferring the copyright of your works to the Dojo
32
+ contributions, you have the legal right to contribute and you are transferring the copyright of your works to the Dojo
22
33
Foundation.
23
34
24
35
If you are an unfamiliar contributor to the committer assessing your pull request, it is best to make it clear how
@@ -28,6 +39,28 @@ If your GitHub user id you are submitting your pull request from differs from th
28
39
which you have signed your CLA under, you should specifically note what you have your CLA filed under (and for CCLA
29
40
that you are listed under your companies authorised contributors).
30
41
42
+ ## Coding Style and Linting
43
+
44
+ The project has a very specific coding style that are checked using this [ jshintrc] . All pull requests should adhere to this.
45
+
46
+ ## Inline Documentation
47
+
48
+ For now our inline API documentation is using [ DojoDoc] [ ] . Any pull request should ensure it has updated the inline
49
+ documentation appropriately or added the appropriate inline documentation.
50
+
51
+ ## Test Cases
52
+
53
+ If the pull request changes the functional behaviour or is fixing a defect, the unit test cases should be modified to
54
+ reflect this. The committer reviewing your pull request is likely to request the appropriate changes in the test
55
+ cases. The test case must be written using [ Intern] .
56
+
57
+ It is expected that you will have tested your changes against the existing test cases and appropriate platforms prior to
58
+ submitting your pull request.
59
+
60
+ ## Licensing
61
+
62
+ All of your submissions are licensed under "New" BSD license.
63
+
31
64
# Submitting a Pull Request
32
65
33
66
The following are the general steps you should follow in creating a pull request. Subsequent pull requests only need
@@ -59,21 +92,17 @@ layer of structure of how repositories can relate to each other.
59
92
Once you have successfully forked your repository, you will need to clone it locally to your machine:
60
93
61
94
``` bash
62
- $ git clone
--recursive [email protected] :username/
dijit .git
95
+ $ git clone
[email protected] :username/
pointer .git
63
96
```
64
97
65
- This will clone your fork to your current path in a directory named ` dijit ` .
66
-
67
- It is important that you clone recursively for `` dojox `` , `` demos `` or `` util `` because some of the code is contained in
68
- submodules. You won't be able to submit your changes to the repositories that way though. If you are working on any of
69
- these sub-projects, you should contact those project leads to see if their workflow differs.
98
+ This will clone your fork to your current path in a directory named ` pointer ` .
70
99
71
100
You should also setup the ` upstream ` repository. This will allow you to take changes from the "master" repository
72
101
and merge them into your local clone and then push them to your GitHub fork:
73
102
74
103
``` bash
75
- $ cd dojo
76
- $ git remote add upstream
[email protected] :dojo/
dijit .git
104
+ $ cd pointer
105
+ $ git remote add upstream
[email protected] :
ibm- dojo/
pointer .git
77
106
$ git fetch upstream
78
107
```
79
108
@@ -94,15 +123,15 @@ a new branch from there. While the name of the branch can be anything, it can o
94
123
you might be working on. For example:
95
124
96
125
``` bash
97
- $ git checkout -b t12345 master
98
- Switched to a new branch ' t12345 '
126
+ $ git checkout -b t12 master
127
+ Switched to a new branch ' t12 '
99
128
```
100
129
101
130
You will then be on the feature branch. You can verify what branch you are on like this:
102
131
103
132
``` bash
104
133
$ git status
105
- # On branch t12345
134
+ # On branch t12
106
135
nothing to commit, working directory clean
107
136
```
108
137
@@ -119,8 +148,8 @@ $ git status
119
148
#
120
149
# modified: somefile.js
121
150
#
122
- $ git commit -m " Corrects some defect, fixes #12345, refs #12346 "
123
- [t12345 0000000] Corrects some defect, fixes # 12345, refs #12346
151
+ $ git commit -m " Corrects some defect, fixes #12 "
152
+ [t12 0000000] Corrects some defect, fixes # 12
124
153
1 file changed, 2 insertions(+), 2 deletions(-)
125
154
```
126
155
@@ -137,7 +166,7 @@ When you are ready to push your commit to your GitHub repository for the first t
137
166
following:
138
167
139
168
``` bash
140
- $ git push -u origin t12345
169
+ $ git push -u origin t12
141
170
```
142
171
143
172
After the first time, you simply need to do:
@@ -165,52 +194,17 @@ You will get notified about the status of your pull request based on your GitHub
165
194
Your request will be reviewed. It may be merged directly, or you may receive feedback or questions on your pull
166
195
request.
167
196
168
- # What Makes a Successful Pull Request?
169
-
170
- Having your contribution accepted is more than just the mechanics of getting your contribution into a pull request,
171
- there are several other things that are expected when contributing to the Dojo Toolkit which are covered below.
172
-
173
- ## Coding Style and Linting
174
-
175
- Dojo has a very specific [ coding style] [ styleguide ] . All pull requests should adhere to this.
176
-
177
- ## Inline Documentation
178
-
179
- Dojo has an inline API documentation called [ DojoDoc] [ ] . Any pull request should ensure it has updated the inline
180
- documentation appropriately or added the appropriate inline documentation.
181
-
182
- ## Test Cases
183
-
184
- If the pull request changes the functional behaviour or is fixing a defect, the unit test cases should be modified to
185
- reflect this. The committer reviewing your pull request is likely to request the appropriate changes in the test
186
- cases. Dojo utilises its own test harness called [ D.O.H.] [ ] and is available as part of the [ dojo/util] [ ] repository.
187
-
188
- It is expected that you will have tested your changes against the existing test cases and appropriate platforms prior to
189
- submitting your pull request.
190
-
191
- ## Licensing
192
-
193
- All of your submissions are licensed under a dual "New" BSD/AFL license.
194
-
195
- ## Expect Discussion and Rework
196
-
197
- Unless you have been working with contributing to Dojo for a while, expect a a significant amount of feedback on your
198
- pull requests. We are a very passionate community and even the committers often will provide robust feedback to each
199
- other about their code. Don't be offended by such feedback or feel that your contributions aren't welcome, it is just
200
- that we are quite passionate and Dojo has a long history with many things that are the "Dojo-way" which may be
201
- unfamiliar to those who are just starting to contribute.
202
197
203
198
[ help documentation ] : http://help.github.com/send-pull-requests
204
- [ bug database ] : http://bugs.dojotoolkit.org/
205
- [ support forum ] : http://dojotoolkit.org/community/
206
- [ dojo-contrib ] : http://mail.dojotoolkit.org/mailman/listinfo/dojo-contributors
199
+ [ bug database ] : ../../issues
200
+ [ ml-users ] : http://dojotoolkit.org/community/
201
+ [ ml-dev ] : http://mail.dojotoolkit.org/mailman/listinfo/dojo-contributors
207
202
[ cla ] : http://dojofoundation.org/about/cla
208
203
[ claCheck ] : http://dojofoundation.org/about/claCheck
209
204
[ Creating a Pull Request ] : https://help.github.com/articles/creating-a-pull-request
210
205
[ Fork a Repo ] : https://help.github.com/articles/fork-a-repo
211
- [ styleguide ] : http://dojotoolkit.org/reference-guide/developer/styleguide.html
206
+ [ jshintrc ] : ./.jshintrc
212
207
[ DojoDoc ] : http://dojotoolkit.org/reference-guide/developer/markup.html
213
- [ D.O.H. ] : http://dojotoolkit.org/reference-guide/util/doh.html
214
- [ dojo/util ] : https://github.com/dojo/util
208
+ [ Intern ] : http://theintern.io/
215
209
[ interactive rebase ] : http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
216
- [ rebasing ] : http://git-scm.com/book/en/Git-Branching-Rebasing
210
+ [ rebasing ] : http://git-scm.com/book/en/Git-Branching-Rebasing
0 commit comments