Skip to content

Commit 34a0773

Browse files
dbarnespaychexdbarnespaychex
committed
chore: preparing for open source
1 parent 28aaea2 commit 34a0773

File tree

5 files changed

+274
-28
lines changed

5 files changed

+274
-28
lines changed

Diff for: ‎CONTRIBUTING.md

+54-24
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,60 @@ Thank you for wanting to contribute to the `@paychex/core` library!
44

55
Please read this entire file before pushing any code to the repository.
66

7+
## Pull Requests
8+
9+
Please ensure you do the following before submitting any code for review:
10+
11+
- Reach out to at least one repository maintainer early in development to assist with design decisions.
12+
- Use [Gitflow](https://nvie.com/posts/a-successful-git-branching-model/) to name your branches. For normal contributions, that means creating a `feature/<name>` or `bugfix/<name>` branch off of the `develop` branch.
13+
- Ensure your test coverage is at 100%.
14+
- Write documentation for any public methods.
15+
- Use [conventional commit](https://www.conventionalcommits.org/en/v1.0.0-beta.3/#summary) messages on all commits.
16+
17+
Finally, because your code will be consumed by many other developers, please allow enough time for the maintainers to review your proposed changes thoroughly.
18+
19+
## Commit Messages
20+
21+
Try to follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4) standard. The following commit types should be used:
22+
23+
type | description
24+
:--- | :---
25+
feat | The commit adds a new feature.
26+
fix | The commit fixes a bug.
27+
perf | The commit is solely to improve performance.
28+
docs | The commit only updates or improves documentation.
29+
test | The commit only modifies tests.
30+
refactor | The commit changes code but does not fix a bug or modify public methods.
31+
chore | The commit modifies builds, publishing, source control, or other non-code functionality.
32+
33+
### Example Commit Messages
34+
35+
```text
36+
perf(signals): reuse constructor function
37+
38+
Rather than create a new constructor function on each invocation of
39+
ready(), we now reuse an existing function. This also makes the logic in
40+
autoReset() a bit more readable.
41+
```
42+
43+
```text
44+
feat(stores): remove asObservable wrapper
45+
46+
This functionality can be provided by Store implementers more simply,
47+
and likely better aligned with feature use cases. It also removes a
48+
significant size dependency on RxJS.
49+
50+
BREAKING
51+
```
52+
53+
## Documentation
54+
55+
Make sure your public methods and types are all documented. Use [jsDocs](http://usejsdoc.org/index.html) and run `npm run docs` to ensure your documentation compiles. Include examples of typical use cases.
56+
57+
## Unit Tests
58+
59+
This repository contains code that will be used by many developers. Accordingly, **you should aim for 100% code coverage** of any features you write. Each conditional branch should be tested, edge cases should be considered, and errors should be propagated appropriately.
60+
761
## Design Principles
862

963
Code written for a library is different from application code. A library provides a toolbox for other developers. And much like a screwdriver or a hammer, library code is completely unaware of how it will be used. Also like a tool, each feature in a library should serve a single well-defined purpose.
@@ -171,27 +225,3 @@ export function withFeature( delegate:IDelegate [, options:{[string]: any}] ): I
171225
### Patterns & Principles Summary
172226

173227
Apply single-responsibility and open-closed principles to our code allows us to provide new features easily through `proxy`, `adapter`, and `decorator` wrapper methods.
174-
175-
## Commit Messages
176-
177-
Try to follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/#summary) standard. See [this wiki page](https://wiki.paychex.com/display/ENTAPPS/Git+Commit+Standards) for more information.
178-
179-
## Documentation
180-
181-
Make sure your public methods and types are all documented. Use [jsDocs](http://usejsdoc.org/index.html) and run `npm run docs` to ensure your documentation compiles. Include examples of typical use cases.
182-
183-
## Unit Tests
184-
185-
This repository contains code that will be used by many developers. Accordingly, you should aim for 100% code coverage of any features you write. Each conditional branch should be tested, edge cases should be considered, and errors should be propagated appropriately.
186-
187-
## Pull Requests
188-
189-
Please ensure you do the following before submitting any code for review:
190-
191-
- Use [Paychex Gitflow standards](https://wiki.paychex.com/display/ENTAPPS/GitFlow+for+SSO) to name your branches correctly.
192-
- Use [conventional commit](https://www.conventionalcommits.org/en/v1.0.0-beta.3/#summary) messages on all commits.
193-
- Reach out to at least one repository maintainer early in development to assist with design decisions.
194-
- Ensure your test coverage is at 100%.
195-
- Write documentation for any public methods.
196-
197-
Finally, because your code will be consumed by many other developers, please allow enough time for the maintainers to review your proposed changes thoroughly.

Diff for: ‎LICENSE

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

Diff for: ‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ name | description
3636

3737
## Contributing
3838

39-
Before creating a new feature for the `@paychex/core` library, please read [CONTRIBUTING.md](https://code.paychex.com/projects/HTML5/repos/paychex-core/browse/CONTRIBUTING.md?at=refs%2Fheads%2Fdevelop).
39+
Before creating a new feature for the `@paychex/core` library, please read [CONTRIBUTING.md](CONTRIBUTING.md).

Diff for: ‎jsdoc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"search": true,
2626
"menu": {
2727
"Source Code": {
28-
"href": "https://code.paychex.com/projects/HTML5/repos/paychex-core/browse",
28+
"href": "https://github.com/paychex/core",
2929
"target": "_blank",
3030
"class": "menu-item",
3131
"id": "repository"

Diff for: ‎package.json

+16-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,22 @@
33
"version": "0.3.0",
44
"description": "Provides framework-agnostic functionality for use in applications.",
55
"main": "index.js",
6-
"author": "Dan Barnes",
7-
"license": "MIT",
6+
"license": "Apache-2.0",
7+
"author": "Paychex, Inc.",
8+
"contributors": [
9+
{
10+
"name": "Dan Barnes",
11+
"email": "[email protected]"
12+
}
13+
],
14+
"repository": {
15+
"type": "git",
16+
"url": "git://github.com/paychex/core.git"
17+
},
18+
"bugs": {
19+
"url": "https://github.com/paychex/core/issues"
20+
},
21+
"homepage": "https://github.com/paychex/core",
822
"devDependencies": {
923
"@babel/core": "^7.5.4",
1024
"@babel/preset-env": "^7.5.4",

0 commit comments

Comments
 (0)