Skip to content

Commit 2eadad3

Browse files
rashmihuntrashmihunt
authoredSep 27, 2016
Readme updates, cleanup of Examples & code
- Readme updates - added/cleaned code under examples - cleaned up code - fixes from code review
·
v4.1.10v1.0.0
1 parent 7dacc2f commit 2eadad3

18 files changed

+777
-1043
lines changed
 

‎CONTRIBUTING.md

+148-58
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,148 @@
1-
#Contribution Guidelines
2-
3-
Thank you for your support! node-soap wouldn't be where it is today without contributors like you who are willing to take the time to improve it for everyone else.
4-
5-
Because SOAP Web Services can differ amongst implementations, there is high risk involved in making changes. What works for your WSDL, might not work with another. It is therefore _essential_ that contributors to node-soap adhere to these guidelines.
6-
7-
##Filing issues
8-
* Please look through the issues that are currently open in the attempt to find one that matches yours.
9-
* If you find an issue that matches yours, please submit your documentation about it there as it will help everyone understand it more.
10-
* If you plan on fixing the issue, please take the time to fix it first and then provide a Pull Request.
11-
* Please be descriptive in your issue titles I.E. "Error occurs when calling client.foo on WSDL without import element."
12-
13-
##Submitting a Pull Request
14-
* Pull Requests **must be rebased to the latest version of master and _squashed to a single commit_** i.e. `git checkout master;git pull upstream master;git checkout feature-branch;git rebase -i master`
15-
* Pull Requests **must have accompanying tests** (either Unit or Request/Response Sample tests are welcome). Your chances of getting the PR merged are very low if you don't provide any tests.
16-
* Pull Requests must have passing travis builds.
17-
* Pull Requests must be able to merge automatically from github.
18-
* Please **do not close a pull request due to a request to rebase**. Git is a powerful VCS and deserves your time in learning how to rebase properly. Pull Requests are updated automatically on github when you force push to your branch after rebasing.
19-
20-
Very useful articles/help on this topic:
21-
- [GitHub Help - About Git rebase](https://help.github.com/articles/about-git-rebase/)
22-
- [GitHub Help - Using Git rebase](https://help.github.com/articles/using-git-rebase/)
23-
24-
* Please use descriptive commit messages. Commit messages are used during the creation of history and release notes. You'll make the job of maintainers much easier by doing this.
25-
26-
##Making Changes
27-
* Any and all pull requests to change documentation or typos are welcome!
28-
* Any WSDL checked in should be as small and as generic as possible. This is to keep the size of the codebase from growing too large and to keep the reason for submitting the WSDL clear I.E. if the WSDL was submitted because attributes were not being parsed on response XML, then it would be appropriate to submit a WSDL that defines a response with attributes *and nothing else*. If you find an issue with the parser not being able to handle large WSDLs, then it would be appropriate to submit a large WSDL to recreate the issue with.
29-
* If your issue is WSDL related:
30-
````
31-
1. Make your WSDL as generic as possible to recreate the issue
32-
2. Add the WSDL to the appropriate path in test/wsdl.
33-
3. Commit your changes to a feature branch within your fork.
34-
4. Issue a pull request.
35-
````
36-
37-
* If your issue is client related:
38-
````
39-
1. Capture the request / response XML via client.lastRequest and client.lastResponse as well as the WSDL.
40-
2. Make the WSDL, request, and response XML as generic as possible.
41-
3. Only include the messages or operations that are having issues.
42-
4. Add the appropriate files to test/request-response-samples (see the README therein)
43-
5. Commit your changes to a feature branch within your fork.
44-
6. Issue a pull request
45-
````
46-
47-
* If your issue is neither WSDL nor client related:
48-
````
49-
1. Provide a test of some form in an appropriate *-test.js file under test/
50-
2. Commit your changes to a feature branch within your fork.
51-
3. Issue a pull request.
52-
````
53-
54-
##Issue Expiration
55-
Any pull request or issue filed is subject to an expiration date. We will close any open issue that has not received a response within a 2 week timeframe. The goal is not to sweep dirt under the rug, but to keep the focus on merging in pull requests. Please provide pull requests that meet the above criteria wherever possible.
56-
57-
##Other ways you can contribute
58-
Please add response, request, and WSDL files to test/wsdl, and test/request-response-samples (see README therein). Doing so documents behavior and reduces the likelihood that bugs will be introduced by future pull requests.
1+
### Contributing ###
2+
3+
Thank you for your interest in `strong-soap`, an open source project
4+
administered by StrongLoop.
5+
6+
Contributing to `strong-soap` is easy. In a few simple steps:
7+
8+
* Ensure that your effort is aligned with the project's roadmap by
9+
talking to the maintainers, especially if you are going to spend a
10+
lot of time on it.
11+
12+
* Make something better or fix a bug.
13+
14+
* Adhere to code style outlined in the [Google C++ Style Guide][] and
15+
[Google Javascript Style Guide][].
16+
17+
* Sign the [Contributor License Agreement](https://cla.strongloop.com/agreements/strongloop/strong-soap)
18+
19+
* Submit a pull request through Github.
20+
21+
22+
### Contributor License Agreement ###
23+
24+
```
25+
Individual Contributor License Agreement
26+
27+
By signing this Individual Contributor License Agreement
28+
("Agreement"), and making a Contribution (as defined below) to
29+
StrongLoop, Inc. ("StrongLoop"), You (as defined below) accept and
30+
agree to the following terms and conditions for Your present and
31+
future Contributions submitted to StrongLoop. Except for the license
32+
granted in this Agreement to StrongLoop and recipients of software
33+
distributed by StrongLoop, You reserve all right, title, and interest
34+
in and to Your Contributions.
35+
36+
1. Definitions
37+
38+
"You" or "Your" shall mean the copyright owner or the individual
39+
authorized by the copyright owner that is entering into this
40+
Agreement with StrongLoop.
41+
42+
"Contribution" shall mean any original work of authorship,
43+
including any modifications or additions to an existing work, that
44+
is intentionally submitted by You to StrongLoop for inclusion in,
45+
or documentation of, any of the products owned or managed by
46+
StrongLoop ("Work"). For purposes of this definition, "submitted"
47+
means any form of electronic, verbal, or written communication
48+
sent to StrongLoop or its representatives, including but not
49+
limited to communication or electronic mailing lists, source code
50+
control systems, and issue tracking systems that are managed by,
51+
or on behalf of, StrongLoop for the purpose of discussing and
52+
improving the Work, but excluding communication that is
53+
conspicuously marked or otherwise designated in writing by You as
54+
"Not a Contribution."
55+
56+
2. You Grant a Copyright License to StrongLoop
57+
58+
Subject to the terms and conditions of this Agreement, You hereby
59+
grant to StrongLoop and recipients of software distributed by
60+
StrongLoop, a perpetual, worldwide, non-exclusive, no-charge,
61+
royalty-free, irrevocable copyright license to reproduce, prepare
62+
derivative works of, publicly display, publicly perform,
63+
sublicense, and distribute Your Contributions and such derivative
64+
works under any license and without any restrictions.
65+
66+
3. You Grant a Patent License to StrongLoop
67+
68+
Subject to the terms and conditions of this Agreement, You hereby
69+
grant to StrongLoop and to recipients of software distributed by
70+
StrongLoop a perpetual, worldwide, non-exclusive, no-charge,
71+
royalty-free, irrevocable (except as stated in this Section)
72+
patent license to make, have made, use, offer to sell, sell,
73+
import, and otherwise transfer the Work under any license and
74+
without any restrictions. The patent license You grant to
75+
StrongLoop under this Section applies only to those patent claims
76+
licensable by You that are necessarily infringed by Your
77+
Contributions(s) alone or by combination of Your Contributions(s)
78+
with the Work to which such Contribution(s) was submitted. If any
79+
entity institutes a patent litigation against You or any other
80+
entity (including a cross-claim or counterclaim in a lawsuit)
81+
alleging that Your Contribution, or the Work to which You have
82+
contributed, constitutes direct or contributory patent
83+
infringement, any patent licenses granted to that entity under
84+
this Agreement for that Contribution or Work shall terminate as
85+
of the date such litigation is filed.
86+
87+
4. You Have the Right to Grant Licenses to StrongLoop
88+
89+
You represent that You are legally entitled to grant the licenses
90+
in this Agreement.
91+
92+
If Your employer(s) has rights to intellectual property that You
93+
create, You represent that You have received permission to make
94+
the Contributions on behalf of that employer, that Your employer
95+
has waived such rights for Your Contributions, or that Your
96+
employer has executed a separate Corporate Contributor License
97+
Agreement with StrongLoop.
98+
99+
5. The Contributions Are Your Original Work
100+
101+
You represent that each of Your Contributions are Your original
102+
works of authorship (see Section 8 (Submissions on Behalf of
103+
Others) for submission on behalf of others). You represent that to
104+
Your knowledge, no other person claims, or has the right to claim,
105+
any right in any intellectual property right related to Your
106+
Contributions.
107+
108+
You also represent that You are not legally obligated, whether by
109+
entering into an agreement or otherwise, in any way that conflicts
110+
with the terms of this Agreement.
111+
112+
You represent that Your Contribution submissions include complete
113+
details of any third-party license or other restriction (including,
114+
but not limited to, related patents and trademarks) of which You
115+
are personally aware and which are associated with any part of
116+
Your Contributions.
117+
118+
6. You Don't Have an Obligation to Provide Support for Your Contributions
119+
120+
You are not expected to provide support for Your Contributions,
121+
except to the extent You desire to provide support. You may provide
122+
support for free, for a fee, or not at all.
123+
124+
6. No Warranties or Conditions
125+
126+
StrongLoop acknowledges that unless required by applicable law or
127+
agreed to in writing, You provide Your Contributions on an "AS IS"
128+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER
129+
EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES
130+
OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR
131+
FITNESS FOR A PARTICULAR PURPOSE.
132+
133+
7. Submission on Behalf of Others
134+
135+
If You wish to submit work that is not Your original creation, You
136+
may submit it to StrongLoop separately from any Contribution,
137+
identifying the complete details of its source and of any license
138+
or other restriction (including, but not limited to, related
139+
patents, trademarks, and license agreements) of which You are
140+
personally aware, and conspicuously marking the work as
141+
"Submitted on Behalf of a Third-Party: [named here]".
142+
143+
8. Agree to Notify of Change of Circumstances
144+
145+
You agree to notify StrongLoop of any facts or circumstances of
146+
which You become aware that would make these representations
147+
inaccurate in any respect. Email us at callback@strongloop.com.
148+
```

0 commit comments

Comments
 (0)
Please sign in to comment.