Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Commit cb2bfa8

Browse files
author
Derek Barncard
committed
Added contribution guidelines
1 parent c868c17 commit cb2bfa8

File tree

4 files changed

+185
-143
lines changed

4 files changed

+185
-143
lines changed

‎CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# How to contribute
2+
3+
We're excited you're considering contributing to our project! Your patches are essential to keeping our SDKs bug free and up-to-date. We want to keep it as easy as possible to contribute. There are only a few guidelines you must follow that will allow us to keep up with pull requests and maintain a high quality code base.
4+
5+
## Getting Started
6+
7+
* Make sure you have a [GitHub account](https://github.com/signup/free)
8+
* Make sure you have a [HelloSign account](http://www.hellosign.com)
9+
* Submit a new [issue ticket](https://github.com/HelloFax/hellosign-java-sdk/issues), assuming one does not already exist.
10+
* Clearly describe the issue including steps to reproduce when it is a bug.
11+
* Make sure to include the version you are using which has the issue (and confirm that the issue you are having has not been fixed in a later version)
12+
* Fork the repository on GitHub
13+
14+
## Making Changes
15+
16+
* Make commits of logical units.
17+
* Check for unnecessary whitespace with `git diff --check` before committing.
18+
* Make sure your commit messages are in [the proper format](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
19+
* Make sure you have added any necessary tests for your changes.
20+
* Run all unit tests, if available, to ensure nothing else was accidentally broken.
21+
22+
### Making trivial changes
23+
24+
For changes of a trivial nature to comments and documentation, it is not
25+
always necessary to create a new issue ticket.
26+
27+
## Submitting Changes
28+
29+
* Push your changes to your fork of the repository.
30+
* Submit a pull request to the repository in the HelloFax organization.
31+
* Update your issue ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
32+
* Include a link to the pull request in the ticket.
33+
* The HelloSign dev team looks at Pull Requests on a regular basis.
34+
* After feedback has been given we expect responses within two weeks. After two
35+
weeks we may close the pull request if it isn't showing any activity.
36+
37+
# Additional Resources
38+
39+
* [General GitHub documentation](http://help.github.com/)
40+
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
41+
* [HelloSign API documentation](https://www.hellosign.com/api/documentation)
42+
* [HelloSign API HipChat room](https://www.hipchat.com/gq4BMFKt1)

‎LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 hellosign.com
3+
Copyright (c) 2015 hellosign.com
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

‎README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -106,41 +106,41 @@ for signature_request in signature_request_list:
106106
````python
107107
files = ["NDA.pdf", "AppendixA.pdf"]
108108
signers = [
109-
{"name": "Jack", "email_address": "[email protected]"},
109+
{"name": "Jack", "email_address": "[email protected]"},
110110
{"name": "Jill", "email_address": "[email protected]"}
111111
]
112112
cc_email_addresses = ["[email protected]", "[email protected]"]
113113

114114
# Send a signature request with remote files
115115
signature_request = client.send_signature_request(
116-
test_mode=True,
117-
files=None,
118-
file_urls=["http://www.example.com/download/sample.pdf"],
119-
title="NDA with Acme Co.",
120-
subject="The NDA we talked about",
121-
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
122-
signing_redirect_url=None,
123-
signers=signers,
116+
test_mode=True,
117+
files=None,
118+
file_urls=["http://www.example.com/download/sample.pdf"],
119+
title="NDA with Acme Co.",
120+
subject="The NDA we talked about",
121+
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
122+
signing_redirect_url=None,
123+
signers=signers,
124124
cc_email_addresses=cc_email_addresses)
125125

126126
# Send a signature request with uploaded files
127127
signature_request = client.send_signature_request(
128-
test_mode=True,
129-
files=files,
130-
file_urls=None,
131-
title="NDA with Acme Co.",
132-
subject="The NDA we talked about",
133-
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
134-
signing_redirect_url=None,
135-
signers=signers,
128+
test_mode=True,
129+
files=files,
130+
file_urls=None,
131+
title="NDA with Acme Co.",
132+
subject="The NDA we talked about",
133+
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
134+
signing_redirect_url=None,
135+
signers=signers,
136136
cc_email_addresses=cc_email_addresses)
137137
````
138138

139139
#### Send a Signature Request with Template
140140

141141
````python
142142
signers = [
143-
{"name": "Jack", "email_address": "[email protected]"},
143+
{"name": "Jack", "email_address": "[email protected]"},
144144
{"name": "Jill", "email_address": "[email protected]"}
145145
]
146146
cc_email_addresses = ["[email protected]", "[email protected]"]
@@ -149,20 +149,20 @@ ccs = [
149149
{ "email_address": "[email protected]", "role_name": "Lawyer 2" }
150150
]
151151
custom_fields = [
152-
{ "Field 1": "Value 1" },
152+
{ "Field 1": "Value 1" },
153153
{ "Field 2": "Value 2" }
154154
]
155155

156156
# Send a signature request with uploaded files
157157
signature_request = client.send_signature_request_with_template(
158-
test_mode=True,
159-
template_id="fa5c8a0b0f492d768749333ad6fcc214c111e967",
160-
title="NDA with Acme Co.",
161-
subject="The NDA we talked about",
162-
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
163-
signing_redirect_url=None,
164-
signers=signers,
165-
ccs=ccs,
158+
test_mode=True,
159+
template_id="fa5c8a0b0f492d768749333ad6fcc214c111e967",
160+
title="NDA with Acme Co.",
161+
subject="The NDA we talked about",
162+
message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
163+
signing_redirect_url=None,
164+
signers=signers,
165+
ccs=ccs,
166166
custom_fields=custom_fields)
167167
````
168168

@@ -172,7 +172,7 @@ signature_request = client.send_signature_request_with_template(
172172

173173
````python
174174
signers = [
175-
{"name": "Jack", "email_address": "[email protected]"},
175+
{"name": "Jack", "email_address": "[email protected]"},
176176
{"name": "Jill", "email_address": "[email protected]"}
177177
]
178178
signature_request = client.send_signature_request_embedded(
@@ -191,7 +191,7 @@ signature_request = client.send_signature_request_embedded(
191191
for signature in signature_request.signatures:
192192
embedded_obj = client.get_embedded_object(signature.signature_id)
193193
sign_url = embedded_obj.sign_url
194-
194+
195195
````
196196

197197
More information about the asscociated front-end code can be found [here](https://www.hellosign.com/api/embeddedSigningWalkthrough#ClientSide)
@@ -255,7 +255,7 @@ We do not allow app callbacks (event or OAuth) to be set to localhost. However i
255255
```
256256
The MIT License (MIT)
257257
258-
Copyright (C) 2014 hellosign.com
258+
Copyright (C) 2015 hellosign.com
259259
260260
Permission is hereby granted, free of charge, to any person obtaining a copy
261261
of this software and associated documentation files (the "Software"), to deal
@@ -274,4 +274,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
274274
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
275275
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
276276
SOFTWARE.
277-
```
277+
```

0 commit comments

Comments
 (0)