Skip to content

Commit 56be28f

Browse files
Initial Commit
1 parent a92641d commit 56be28f

27 files changed

+10095
-1
lines changed

.editorconfig

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# top-most EditorConfig file
2+
root = true
3+
4+
# Unix-style newlines with a newline ending every file
5+
[*]
6+
end_of_line = lf
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 2
10+
trim_trailing_whitespace = true
11+
12+
[package.json]
13+
indent_style = space
14+
indent_size = 2

.eslintrc.js

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
module.exports = {
2+
root: true,
3+
parserOptions: {
4+
parser: 'babel-eslint',
5+
ecmaVersion: 8
6+
},
7+
env: {
8+
es6: true,
9+
node: true,
10+
browser: true,
11+
jest: true
12+
},
13+
plugins: [
14+
'prettier'
15+
],
16+
extends: [
17+
'eslint:recommended',
18+
'plugin:import/errors',
19+
'plugin:import/warnings',
20+
'prettier/standard'
21+
],
22+
rules: {
23+
'prettier/prettier': [
24+
'error',
25+
{
26+
'singleQuote': true,
27+
'bracketSpacing': true,
28+
'semi': false,
29+
'printWidth': 500
30+
}
31+
],
32+
'no-empty': [
33+
'error',
34+
{
35+
'allowEmptyCatch': true
36+
}
37+
],
38+
'no-console': 0,
39+
'no-control-regex': 0,
40+
'no-useless-escape': 0,
41+
},
42+
globals: {}
43+
}

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

.github/CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 e-mail
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]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
![Logo](https://red-van-workshop.s3.us-east-1.amazonaws.com/logo.png "Logo")
2+
3+
Contributing Guide
4+
===
5+
6+
<img src="https://octodex.github.com/images/inspectocat.jpg" width="320" style="display: block; margin: 0 auto;">
7+
8+
> We are excited that you are interested in contributing to our project. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
9+
10+
Issues & Feature Requests
11+
---
12+
13+
### Bug Fix
14+
15+
[![Staging Environment](https://img.shields.io/badge/Create-Bug_Report-fbca04.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/redvanworkshop/sfcc-cartridge-diff/issues/new?labels=Bug%20Report)
16+
17+
> We're sorry things are not working as expected, and want to get things fixed ASAP. In order to help us do that, we need a few things from you.
18+
19+
1. Create a [New Bug Report](https://github.com/redvanworkshop/sfcc-cartridge-diff/issues/new?labels=Bug%20Report)
20+
2. Enter a Short but Descriptive Title for the Issue
21+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A`
22+
4. Look for the `Labels` section, and select `Bug Report` from the drop down menu
23+
5. Click `Submit new issue` button
24+
25+
### Feature Request
26+
27+
[![Staging Environment](https://img.shields.io/badge/Create-Feature_Request-9933cc.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/redvanworkshop/sfcc-cartridge-diff/issues/new?labels=Feature%20Request)
28+
29+
> Got an idea for a new feature? We'd love to hear it! In order to get this knocked out, we will need a few things from you.
30+
31+
1. Create a [New Feature Request](https://github.com/redvanworkshop/sfcc-cartridge-diff/issues/new?labels=Feature%20Request)
32+
2. Enter a Short but Descriptive Title for the Feature Request
33+
3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` ( you can delete the `Steps to Duplicate:` section as that does not apply )
34+
4. Look for the `Labels` section, and select `Feature Request` from the drop down menu
35+
5. Click `Submit new issue` button
36+
37+
Pull Requests
38+
---
39+
40+
[![Staging Environment](https://img.shields.io/badge/Create-Pull_Request-006b75.svg?style=for-the-badge&logo=github&logoColor=ffffff&logoWidth=16)](https://github.com/redvanworkshop/sfcc-cartridge-diff/compare?labels=Ready%20For%20Code%20Review)
41+
42+
### Bug Fix
43+
44+
> Each Bug Fix reported on GitHub should have its own `fix/*` branch. The branch name should be formatted `fix/###-issue-name` where `###` is the GitHub Issue Number, and `issue-name` is a 1-3 word summary of the issue.
45+
46+
1. Checkout latest `develop` branch
47+
2. Pull down the latest changes via `git pull`
48+
3. Create a new branch with the structure `fix/*`, e.g. `fix/123-broken-form`
49+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
50+
5. Tag your new Pull Request with `Ready for Code Review`
51+
52+
### Feature Request
53+
54+
> Each New Feature should reside in its own `feature/` branch. The branch name should be formatted `feature/###-feature-name` where `###` is the GitHub Issue Number, and `feature-name` is a 1-3 word summary of the feature.
55+
56+
1. Checkout latest `develop` branch
57+
2. Pull down the latest changes via `git pull`
58+
3. Create a new branch with the structure `feature/*`, e.g. `feature/123-mobile-header`
59+
4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop`
60+
5. Tag your new Pull Request with `Ready for Code Review`

.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'Bug Report'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. macOS]
28+
- Version [e.g. 11.2]
29+
- Terminal [e.g. zsh]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Question
3+
about: I have a Question about this project
4+
title: ''
5+
labels: 'Question'
6+
assignees: ''
7+
8+
---
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'Feature Request'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Overview:
2+
---
3+
4+
TEXT
5+
6+
Reviewer:
7+
---
8+
9+
> Where should the reviewer start? How to Test? Background Context? etc ( required )
10+
11+
TEXT
12+
13+
Checklist:
14+
---
15+
16+
> I have tested each of the following, and they work as expected: ( required )
17+
18+
- [ ] Meets [Contributing Guide](https://github.com/redvanworkshop/sfcc-cartridge-diff/blob/develop/.github/CONTRIBUTING.md) Requirements
19+
- [ ] Pulled in the Latest Code from the `develop` branch
20+
- [ ] Works on a Desktop / Laptop Device
21+
- [ ] Works on a Mobile Device
22+
- [ ] `npm test` Does Not Generate Errors
23+
24+
Documentation:
25+
---
26+
27+
> Screenshots, Attachments, Linked GitHub Issues, etc ( optional )
28+
29+
30+
31+
#### What GIF best describes this PR or how it makes you feel?
32+
33+
> Drag & Drop Something Fun Here ( optional )

.github/cla/agreement.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
![Logo](https://red-van-workshop.s3.us-east-1.amazonaws.com/logo.png "Logo")
2+
3+
RVW Individual Contributor License Agreement
4+
===
5+
6+
Thank you for your interest in contributing to open source software projects (“Projects”) made available by Red Van Workshop or its affiliates (“RVW”). This Individual Contributor License Agreement (“Agreement”) sets out the terms governing any source code, object code, bug fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or other works of authorship that you submit or have submitted, in any form and in any manner, to RVW in respect of any of the Projects (collectively “Contributions”). If you have any questions respecting this Agreement, please contact [email protected].
7+
8+
You agree that the following terms apply to all of your past, present and future Contributions. Except for the licenses granted in this Agreement, you retain all of your right, title and interest in and to your Contributions.
9+
10+
### Copyright License
11+
12+
You hereby grant, and agree to grant, to RVW a non-exclusive, perpetual, irrevocable, worldwide, fully-paid, royalty-free, transferable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute your Contributions and such derivative works, with the right to sublicense the foregoing rights through multiple tiers of sublicensees.
13+
14+
### Patent License
15+
16+
You hereby grant, and agree to grant, to RVW a non-exclusive, perpetual, irrevocable, worldwide, fully-paid, royalty-free, transferable patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your Contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your Contributions alone or by combination of your Contributions with the Project to which such Contributions were submitted, with the right to sublicense the foregoing rights through multiple tiers of sublicensees.
17+
18+
### Moral Rights
19+
20+
To the fullest extent permitted under applicable law, you hereby waive, and agree not to assert, all of your “moral rights” in or relating to your Contributions for the benefit of RVW, its assigns, and their respective direct and indirect sublicensees.
21+
22+
### Third Party Content/Rights
23+
24+
If your Contribution includes or is based on any source code, object code, bug fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or other works of authorship that were not authored by you (“Third Party Content”) or if you are aware of any third party intellectual property or proprietary rights associated with your Contribution (“Third Party Rights”), then you agree to include with the submission of your Contribution full details respecting such Third Party Content and Third Party Rights, including, without limitation, identification of which aspects of your Contribution contain Third Party Content or are associated with Third Party Rights, the owner/author of the Third Party Content and Third Party Rights, where you obtained the Third Party Content, and any applicable third party license terms or restrictions respecting the Third Party Content and Third Party Rights. For greater certainty, the foregoing obligations respecting the identification of Third Party Content and Third Party Rights do not apply to any portion of a Project that is incorporated into your Contribution to that same Project.
25+
26+
### Representations
27+
28+
You represent that, other than the Third Party Content and Third Party Rights identified by you in accordance with this Agreement, you are the sole author of your Contributions and are legally entitled to grant the foregoing licenses and waivers in respect of your Contributions. If your Contributions were created in the course of your employment with your past or present employer(s), you represent that such employer(s) has authorized you to make your Contributions on behalf of such employer(s) or such employer(s) has waived all of their right, title or interest in or to your Contributions.
29+
30+
### Disclaimer
31+
32+
To the fullest extent permitted under applicable law, your Contributions are provided on an "asis" basis, without any warranties or conditions, express or implied, including, without limitation, any implied warranties or conditions of non-infringement, merchantability or fitness for a particular purpose. You are not required to provide support for your Contributions, except to the extent you desire to provide support.
33+
34+
### No Obligation
35+
36+
You acknowledge that RVW is under no obligation to use or incorporate your Contributions into any of the Projects. The decision to use or incorporate your Contributions into any of the Projects will be made at the sole discretion of RVW or its authorized delegates.
37+
38+
### Disputes
39+
40+
This Agreement shall be governed by and construed in accordance with the laws of the State of New York, United States of America, without giving effect to its principles or rules regarding conflicts of laws, other than such principles directing application of New York law. The parties hereby submit to venue in, and jurisdiction of the courts located in New York, New York for purposes relating to this Agreement. In the event that any of the provisions of this Agreement shall be held by a court or other tribunal of competent jurisdiction to be unenforceable, the remaining portions hereof shall remain in full force and effect.
41+
42+
### Assignment
43+
44+
You agree that RVW may assign this Agreement, and all of its rights, obligations and licenses hereunder.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Assign to Project
2+
on:
3+
issues:
4+
types:
5+
- opened
6+
pull_request:
7+
types:
8+
- opened
9+
env:
10+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
11+
jobs:
12+
assign_to_project:
13+
runs-on: ubuntu-latest
14+
name: Assign to SFCC Cartridge Diff
15+
steps:
16+
- name: Check GitHub Event Action
17+
uses: srggrs/[email protected]
18+
if: github.event.action == 'opened'
19+
with:
20+
project: 'https://github.com/redvanworkshop/sfcc-cartridge-diff/projects/1'

.github/workflows/build_and_test.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: SFCC Cartridge Diff CI
2+
on:
3+
push:
4+
branches:
5+
- develop
6+
- master
7+
pull_request:
8+
branches:
9+
- develop
10+
- master
11+
jobs:
12+
build_and_test:
13+
runs-on: ubuntu-latest
14+
strategy:
15+
matrix:
16+
node-version: [10.x, 12.x, 14.x]
17+
steps:
18+
- uses: actions/checkout@v2
19+
- name: Use Node.js ${{ matrix.node-version }}
20+
uses: actions/setup-node@v1
21+
with:
22+
node-version: ${{ matrix.node-version }}
23+
- run: npm ci
24+
- run: npm run build --if-present
25+
- run: npm test
26+
- run: npm run test:unit

0 commit comments

Comments
 (0)