Skip to content

Commit 0f90f95

Browse files
wooldridgewooldridge
committed
Merge pull request #249 from wooldridge/issue/246-247
Issue/246 247
2 parents 7cccc5c + fc892f8 commit 0f90f95

File tree

2 files changed

+337
-23
lines changed

2 files changed

+337
-23
lines changed

‎CONTRIBUTING.md‎

Lines changed: 136 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,148 @@
1-
# How to contribute
1+
# Contributing to the Node.js Client API
22

3-
We welcome contributions from the community. If you have a patch that you'd
4-
like us to consider, please do the following:
3+
The MarkLogic Node.js Client API welcomes new contributors. This document will guide you
4+
through the process.
55

6-
* Provide a signed
7-
[Contributor License Agreement](http://developer.marklogic.com/products/cla).
6+
- [Question or Problem?](#question)
7+
- [Issues and Bugs](#issue)
8+
- [Feature Requests](#feature)
9+
- [Submission Guidelines](#submit)
10+
11+
## <a name="question"></a> Have a Question or Problem?
812

9-
* Create an issue for the fix or enhancement.
13+
If you have questions about how to use the Node.js Client API, you can ask on
14+
[StackOverflow](http://stackoverflow.com/tags/marklogic), tagging the question
15+
with MarkLogic.
1016

11-
For a bug, clearly describe the steps to reproduce the problem and the
12-
earliest version that exhibits the problem. For an enhancement, make sure
13-
you have basic agreement about the fix or enhancement.
17+
## <a name="issue"></a> Found an Issue?
18+
If you find a bug in the source code or a mistake in the documentation, you can help us by
19+
submitting an issue to our [GitHub Issue Tracker](https://github.com/marklogic/node-client-api/issues). Even better
20+
you can submit a Pull Request with a fix for the issue you filed.
1421

15-
* [Fork the API repository](https://github.com/marklogic/node-client-api/fork) in your repository on GitHub.
22+
## <a name="feature"></a> Want a Feature?
23+
You can request a new feature by submitting an issue to our [GitHub Issue Tracker](https://github.com/marklogic/node-client-api/issues). If you would like to implement a new feature, first create a new issue and discuss it with one of our project
24+
maintainers.
1625

17-
* Create a branch based on the `master` branch or (if you are in the Early
18-
Access program) on the `develop` branch.
26+
## <a name="submit"></a> Submission Guidelines
1927

20-
* Implement the fix or enhancement.
28+
### Submitting an Issue
29+
If your issue appears to be a bug, and hasn’t been reported, open a new issue.
30+
Providing the following information will increase the chances of your issue being dealt with quickly:
2131

22-
As with other projects, you should include unit tests using the same test
23-
harness (at present, [Mocha](http://visionmedia.github.io/mocha/) and [should](https://github.com/visionmedia/should.js/)). Follow the same style conventions
24-
as existing code. Run jshint on the changes. Create jsdoc for any new
25-
interfaces. (See the gulp tasks for a convenient way to run jshint.)
26-
Run all of the tests to make sure the change doesn't have side effects.
32+
* **Overview of the Issue** - If an error is being thrown a stack trace helps
33+
* **Motivation for or Use Case** - Explain why this is a bug for you
34+
* **Environment** - Which [version of MarkLogic](https://docs.marklogic.com/xdmp.version)? Which version of the Node.js Client API? Mac, Windows, Linux? Details help.
35+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point
36+
to what might be causing the problem (line of code or commit)
2737

28-
* Commit in one or more logical units with clear messages.
38+
### Submitting a Pull Request
2939

30-
* Push to the branch in your fork.
40+
A pull request is the standard way to submit changes to a repository to which you don’t have commit privileges. GitHub provides a nice UI for viewing, discussing, and merging pull requests.
3141

32-
* Create a pull request from your fork and add a comment to the issue.
42+
#### Fill in the CLA
3343

34-
The team will then review the changes and possibly suggest improvements
35-
or alternatives.
44+
Before we can accept your pull request, you need to sign a [Contributor License Agreement](http://developer.marklogic.com/products/cla).
45+
46+
#### Fork the Node.js Client API
47+
48+
Fork the project [on GitHub](https://github.com/marklogic/node-client-api/fork)
49+
and clone your copy.
50+
51+
$ git clone [email protected]:username/node-client-api.git
52+
$ cd node-client-api
53+
$ git remote add upstream git://github.com/marklogic/node-client-api.git
54+
55+
All bug fixes and new features go into the `develop` branch.
56+
57+
We ask that you open an issue in the [issue tracker](https://github.com/marklogic/node-client-api/issues) and get agreement from at least one of the project maintainers before you start coding.
58+
59+
Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of a project maintainer.
60+
61+
#### Create a branch for your changes
62+
63+
Okay, so you have decided to fix something. Create a feature branch and start hacking:
64+
65+
$ git checkout -b issue/123 -t origin/dev
66+
67+
In this case, the branch name, `issue/123`, references the fact that your changes address the issue (#123) that you just filed. Replace the `123` with your issue number. This naming convention is not required, but is generally helpful in navigating your branches.
68+
69+
#### Commit your changes
70+
71+
Make sure git knows your name and email address:
72+
73+
$ git config --global user.name "J. Random User"
74+
$ git config --global user.email "[email protected]"
75+
76+
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
77+
78+
1. The first line should be 50 characters or less and contain a short description of the change including the Issue number prefixed by a hash (`#`).
79+
2. Keep the second line blank.
80+
3. Wrap all other lines at 72 columns.
81+
82+
A good commit log looks like this:
83+
84+
```
85+
Fixes #123: Makes the whatchamajigger work in MarkLogic 8
86+
87+
Body of commit message is a few lines of text, explaining things
88+
in more detail, possibly giving some background about the issue
89+
being fixed, etc etc.
90+
91+
The body of the commit message can be several paragraphs, and
92+
please do proper word-wrap and keep columns shorter than about
93+
72 characters or so. That way `git log` will show things
94+
nicely even when it is indented.
95+
```
96+
97+
The header line should be meaningful; it is what other people see when they
98+
run `git shortlog` or `git log --oneline`.
99+
100+
#### Rebase your repo
101+
102+
Use `git rebase` (not `git merge`) to sync your work from time to time to make sure you don’t stray too far from the active development work.
103+
104+
$ git fetch upstream
105+
$ git rebase upstream/develop
106+
107+
#### Test your code
108+
109+
Be sure to run the tests before submitting your pull request. PRs with failing tests won’t be accepted.
110+
111+
$ node etc/test-setup.js
112+
$ mocha test-basic
113+
$ node etc/test-teardown.js
114+
115+
#### Push your changes
116+
117+
$ git push origin issue/123
118+
119+
#### Submit the pull request
120+
121+
Go to your fork (i.e. https://github.com/username/node-client-api) and select your feature branch. Click the “Pull Request” button and fill out the form.
122+
123+
Pull requests are usually reviewed within a few days. If you get comments that need to be to addressed, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits to existing pull requests.
124+
125+
That’s it. Thanks in advance for your contribution.
126+
127+
128+
#### After your pull request is merged
129+
130+
After your pull request is merged, you can safely delete your branch and pull
131+
the changes from the main (upstream) repository:
132+
133+
* Delete the remote branch on GitHub either through the GitHub web UI or your
134+
local shell as follows:
135+
136+
$ git push origin --delete issue/123
137+
138+
* Check out the dev branch:
139+
140+
$ git checkout develop -f
141+
142+
* Delete the local branch:
143+
144+
$ git branch -D issue/123
145+
146+
* Update your dev with the latest upstream version:
147+
148+
$ git pull --ff upstream develop

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)