Skip to content

Commit ac893b1

Browse files
robertcrockettrobertcrockett
authored
Initial commit
0 parents  commit ac893b1

16 files changed

+828
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to submit a bug
4+
title: "bug: "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## Bug Report
10+
11+
Thanks for reporting an issue, please review the task list below before submitting the
12+
issue. Your issue report will be closed if the issue is incomplete and the below tasks not completed.
13+
14+
## Task List
15+
_Put an `x` in the boxes that apply_
16+
17+
- [ ] Steps to reproduce provided
18+
- [ ] Stacktrace (if present) provided
19+
- [ ] Example that reproduces the problem uploaded to Github
20+
- [ ] Full description of the issue provided (see below)
21+
22+
## Commit or Tag Version
23+
24+
Specify the commit or tag version the issue occurred in
25+
26+
## Expected Behaviour
27+
28+
Describe the expected behavior
29+
30+
## Actual Behaviour
31+
32+
Tell us what happens instead
33+
34+
## Steps to Reproduce
35+
36+
Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application.
37+
38+
1. TODO
39+
2. TODO
40+
3. TODO
41+
42+
## Related Code
43+
44+
If you are able to illustrate the bug with an example, please provide it here.
45+
46+
```
47+
insert short code snippets here
48+
```
49+
50+
## Further comments
51+
52+
List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc.

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "feature: "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
## Feature Request
10+
11+
Thanks for showing an interest in continuing to grow this product! Please review the task list below
12+
before submitting the request. Your feature request will be closed if the information is incomplete
13+
and the below tasks are not completed.
14+
15+
## Task List
16+
_Put an `x` in the boxes that apply_
17+
18+
- [ ] Describe the feature being requested
19+
- [ ] Describe a preferred solution
20+
- [ ] Provide examples or related code if applicable
21+
22+
**If the feature request is approved, would you be willing to submit a PR?**
23+
_(Help can be provided if you need assistance submitting a PR)_
24+
- [ ] Yes
25+
- [ ] No
26+
27+
## Describe the Feature Request
28+
29+
Please provide a clear and concise description of what the feature request is. Please include if your
30+
feature request is related to a problem.
31+
32+
## Describe Preferred Solution
33+
34+
Provide a clear and concise description of what you want to happen.
35+
36+
## Describe Alternatives
37+
38+
If applicable, please provide a clear and concise description of any alternative solutions or features
39+
you've considered.
40+
41+
## Related Code
42+
43+
If you are able to illustrate the new feature request with an example, please provide it here.
44+
45+
## Further comments
46+
47+
Any other additional comments on the new feature can be added here.

‎.github/PULL_REQUEST_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Proposed changes
2+
3+
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
4+
5+
## Types of changes
6+
7+
What types of changes does your code introduce?
8+
_Put an `x` in the boxes that apply_
9+
10+
- [ ] Bugfix (non-breaking change which fixes an issue)
11+
- [ ] New feature (non-breaking change which adds functionality)
12+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
- [ ] Documentation only
14+
15+
## Checklist
16+
17+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
18+
19+
- [ ] I have read the [CONTRIBUTING](https://github.com/Optum/oss-template/blob/main/CONTRIBUTING.md) doc
20+
- [ ] I have added tests that prove my fix is effective or that my feature works
21+
- [ ] I have added necessary documentation (if appropriate)
22+
- [ ] Any dependent changes have been merged and published in downstream modules
23+
24+
## Further comments
25+
26+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

‎.github/labels.yml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
- name: "breaking-change"
3+
color: ee0701
4+
description: "A breaking change for existing users."
5+
- name: "bug"
6+
color: ee0701
7+
description: "Inconsistencies or issues which will cause a problem for users or implementors."
8+
- name: "documentation"
9+
color: 0052cc
10+
description: "Solely about the documentation of the project."
11+
- name: "enhancement"
12+
color: 1d76db
13+
description: "Enhancement of the code, not introducing new features."
14+
- name: "refactor"
15+
color: 1d76db
16+
description: "Improvement of existing code, not introducing new features."
17+
- name: "performance"
18+
color: 1d76db
19+
description: "Improving performance, not introducing new features."
20+
- name: "new-feature"
21+
color: 0e8a16
22+
description: "New features or options."
23+
- name: "maintenance"
24+
color: 2af79e
25+
description: "Generic maintenance tasks."
26+
- name: "ci"
27+
color: 1d76db
28+
description: "Work that improves the continue integration."
29+
- name: "dependencies"
30+
color: 1d76db
31+
description: "Upgrade or downgrade of project dependencies."
32+
33+
- name: "in-progress"
34+
color: fbca04
35+
description: "Issue is currently being resolved by a developer."
36+
- name: "stale"
37+
color: fef2c0
38+
description: "There has not been activity on this issue or PR for quite some time."
39+
- name: "no-stale"
40+
color: fef2c0
41+
description: "This issue or PR is exempted from the stable bot."
42+
43+
- name: "security"
44+
color: ee0701
45+
description: "Marks a security issue that needs to be resolved ASAP."
46+
- name: "incomplete"
47+
color: fef2c0
48+
description: "Marks a PR or issue that is missing information."
49+
- name: "invalid"
50+
color: fef2c0
51+
description: "Marks a PR or issue that is missing information."
52+
53+
- name: "beginner-friendly"
54+
color: 0e8a16
55+
description: "Good first issue for people wanting to contribute to the project."
56+
- name: "help-wanted"
57+
color: 0e8a16
58+
description: "We need some extra helping hands or expertise in order to resolve this."
59+
60+
- name: "priority-critical"
61+
color: ee0701
62+
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error."
63+
- name: "priority-high"
64+
color: b60205
65+
description: "After critical issues are fixed, these should be dealt with before any further issues."
66+
- name: "priority-medium"
67+
color: 0e8a16
68+
description: "This issue may be useful, and needs some attention."
69+
- name: "priority-low"
70+
color: e4ea8a
71+
description: "Nice addition, maybe... someday..."
72+
73+
- name: "major"
74+
color: b60205
75+
description: "This PR causes a major version bump in the version number."
76+
- name: "minor"
77+
color: 0e8a16
78+
description: "This PR causes a minor version bump in the version number."

‎.github/workflows/sourcehawk-scan.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Sourcehawk Scan
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- master
7+
pull_request:
8+
branches:
9+
- main
10+
- master
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Sourcehawk Scan
17+
uses: optum/sourcehawk-scan-github-action@main
18+
19+
20+

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
yarn.lock
2+
package-lock.json

‎CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project email
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [[email protected]][email]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/
75+
[email]: mailto:[email protected]

‎CONTRIBUTING.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contribution Guidelines
2+
3+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Please also review our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md) prior to submitting changes to the project. You will need to attest to this agreement following the instructions in the [Paperwork for Pull Requests](#paperwork-for-pull-requests) section below.
4+
5+
---
6+
7+
# How to Contribute
8+
9+
Now that we have the disclaimer out of the way, let's get into how you can be a part of our project. There are many different ways to contribute.
10+
11+
## Issues
12+
13+
We track our work using Issues in GitHub. Feel free to open up your own issue to point out areas for improvement or to suggest your own new experiment. If you are comfortable with signing the waiver linked above and contributing code or documentation, grab your own issue and start working.
14+
15+
## Coding Standards
16+
17+
We have some general guidelines towards contributing to this project.
18+
19+
### Languages
20+
21+
*Lua*
22+
23+
## Pull Requests
24+
25+
If you've gotten as far as reading this section, then thank you for your suggestions.
26+
27+
## Paperwork for Pull Requests
28+
29+
* Please read this guide and make sure you agree with our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md).
30+
* Make sure git knows your name and email address:
31+
```
32+
$ git config user.name "J. Random User"
33+
$ git config user.email "[email protected]"
34+
```
35+
>The name and email address must be valid as we cannot accept anonymous contributions.
36+
* Write good commit messages.
37+
> Concise commit messages that describe your changes help us better understand your contributions.
38+
* The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary.
39+
> The link will take you to a page that allows you to view our CLA. You will need to click the `Sign in with GitHub to agree button` and authorize the cla-assistant application to access the email addresses associated with your GitHub account. Agreeing to the CLA is also considered to be an attestation that you either wrote or have the rights to contribute the code. All committers to the PR branch will be required to sign the CLA, but you will only need to sign once. This CLA applies to all repositories in the Optum org.
40+
41+
## General Guidelines
42+
43+
Ensure your pull request (PR) adheres to the following guidelines:
44+
45+
* Try to make the name concise and descriptive.
46+
* Give a good description of the change being made. Since this is very subjective, see the [Updating Your Pull Request (PR)](#updating-your-pull-request-pr) section below for further details.
47+
* Every pull request should be associated with one or more issues. If no issue exists yet, please create your own.
48+
* Make sure that all applicable issues are mentioned somewhere in the PR description. This can be done by typing # to bring up a list of issues.
49+
50+
### Updating Your Pull Request (PR)
51+
52+
A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. This applies to both the content documented in the PR and the changed contained within the branch being merged. There's no need to open a new PR. Just edit the existing one.
53+
54+
[email]: mailto:[email protected]

‎INDIVIDUAL_CONTRIBUTOR_LICENSE.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Individual Contributor License Agreement ("Agreement") V2.0
2+
3+
Thank you for your interest in this Optum project (the "PROJECT"). In order to clarify the intellectual property license granted with Contributions from any person or entity, the PROJECT must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the PROJECT and its users; it does not change your rights to use your own Contributions for any other purpose.
4+
5+
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the PROJECT. In return, the PROJECT shall not use Your Contributions in a way that is inconsistent with stated project goals in effect at the time of the Contribution. Except for the license granted herein to the PROJECT and recipients of software distributed by the PROJECT, You reserve all right, title, and interest in and to Your Contributions.
6+
1. Definitions.
7+
8+
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the PROJECT. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
9+
10+
"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the PROJECT for inclusion in, or documentation of, any of the products owned or managed by the PROJECT (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the PROJECT or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the PROJECT for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
11+
12+
2. Grant of Copyright License.
13+
14+
Subject to the terms and conditions of this Agreement, You hereby grant to the PROJECT and to recipients of software distributed by the PROJECT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
15+
16+
3. Grant of Patent License.
17+
18+
Subject to the terms and conditions of this Agreement, You hereby grant to the PROJECT and to recipients of software distributed by the PROJECT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
19+
20+
4. Representations.
21+
22+
(a) You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the PROJECT, or that your employer has executed a separate Corporate CLA with the PROJECT.
23+
24+
(b) You represent that each of Your Contributions is Your original creation (see section 6 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
25+
26+
5. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
27+
28+
6. Should You wish to submit work that is not Your original creation, You may submit it to the PROJECT separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
29+
30+
7. You agree to notify the PROJECT of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

0 commit comments

Comments
 (0)