Skip to content
This repository was archived by the owner on Apr 22, 2024. It is now read-only.

Commit 59b6c56

Browse files
bloodfbloodf
authored
Merge pull request #1 from vuestorefront/standard
refactor: added library standardization
2 parents 471b154 + 343633c commit 59b6c56

22 files changed

+2134
-2
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to @vuestorefront/redis-driver
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## We Develop with Github
11+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12+
13+
## We Use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), So All Code Changes Happen Through Pull Requests
14+
Pull requests are the best way to propose changes to the codebase (we use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests:
15+
16+
1. Fork the repo and create your branch from `develop`.
17+
2. If you've added code that should be tested, add tests.
18+
3. If you've changed APIs, update the documentation.
19+
4. Ensure the test suite passes.
20+
5. Make sure your code lints.
21+
6. Issue that pull request!
22+
23+
## Any contributions you make will be under the MIT Software License
24+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Report bugs using Github's [issues](https://github.com/vuestorefront/redis-driver/issues)
27+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/vuestorefront/redis-driver/issues/new); it's that easy!
28+
29+
## Write bug reports with detail, background, and sample code
30+
**Great Bug Reports** tend to have:
31+
32+
- A quick summary and/or background
33+
- Steps to reproduce
34+
- Be specific!
35+
- Give sample code if you can.
36+
- What you expected would happen
37+
- What actually happens
38+
- The environment you're running the application
39+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
40+
41+
People *love* thorough bug reports. I'm not even kidding.
42+
43+
## Use a Consistent Coding Style
44+
I'm again borrowing these from [AirBnB's Code Style](https://github.com/airbnb/javascript)
45+
46+
* 2 spaces for indentation rather than tabs
47+
* You can try running `npm run lint` for style unification
48+
49+
## License
50+
By contributing, you agree that your contributions will be licensed under its MIT License.

‎.github/ISSUE_TEMPLATE/1.bug-report.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: "🐛 Bug report"
2+
description: Report errors or unexpected behavior
3+
labels:
4+
- bug
5+
- triage-needed
6+
title: '[Bug]: '
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront/redis-driver/issues) before filing a new one!
12+
- type: textarea
13+
id: whattoexpect
14+
attributes:
15+
label: Expected Behavior
16+
placeholder: What were you expecting?
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: whathappened
21+
attributes:
22+
label: Actual Behavior
23+
placeholder: What happened instead??
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: solution
28+
attributes:
29+
label: Possible Solution
30+
description: Also, if possible provide the information on how to implement the solution.
31+
placeholder: Do you have any possible solution or fix for this bug?
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: reproduce
36+
attributes:
37+
label: Steps to reproduce
38+
description: Please provide detailed instructions on how to reproduce.
39+
placeholder: How we can reproduce this bug?
40+
validations:
41+
required: false
42+
- type: input
43+
attributes:
44+
label: What version of Magento 2 integration are you using?
45+
description: 'For example: 1.0.0'
46+
validations:
47+
required: true
48+
- type: input
49+
attributes:
50+
label: What version of Node.js are you using?
51+
description: 'For example: 12.0.0'
52+
validations:
53+
required: true
54+
- type: input
55+
attributes:
56+
label: What browser (and version) are you using?
57+
description: 'For example: Chrome, Safari'
58+
validations:
59+
required: true
60+
- type: input
61+
attributes:
62+
label: What operating system (and version) are you using?
63+
description: 'For example: macOS, Windows'
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: logs
68+
attributes:
69+
label: Relevant log output
70+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
71+
render: shell
72+
- type: checkboxes
73+
id: terms
74+
attributes:
75+
label: Code of Conduct
76+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/redis-driver/blob/master/CODE_OF_CONDUCT.md)
77+
options:
78+
- label: I agree to follow this project's Code of Conduct
79+
required: true

‎.github/ISSUE_TEMPLATE/2.documentation-issue.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: "📚 Documentation Issue"
2+
description: |
3+
Report issues in our documentation
4+
labels:
5+
- documentation
6+
- triage-needed
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Provide a description of requested docs changes
11+
placeholder: Briefly describe which document needs to be corrected.
12+
validations:
13+
required: true
14+
- type: checkboxes
15+
id: fixthebug
16+
attributes:
17+
label: Able to fix / change the documentation?
18+
description: Can you handle this change and create a Pull Request?
19+
options:
20+
- label: 'Yes'
21+
required: false
22+
- label: 'No'
23+
required: false
24+
- type: checkboxes
25+
id: terms
26+
attributes:
27+
label: Code of Conduct
28+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/redis-driver/blob/master/CODE_OF_CONDUCT.md)
29+
options:
30+
- label: I agree to follow this project's Code of Conduct
31+
required: true

‎.github/ISSUE_TEMPLATE/3.feature-request.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "🚀 Feature Request"
2+
description: Sugest a new feature request or improvement on the project
3+
title: '[Feature]: '
4+
labels:
5+
- feature
6+
- enhancement
7+
- triage-needed
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Please, provide as many information, and knowledge so the feature can be correctly designed and developed.
14+
- type: textarea
15+
id: suggestion
16+
attributes:
17+
label: How the project can be improved?
18+
description: What is the motivation for adding / enhancing this feature? Can you describe a concrete use case for this feature or why one of current ones should be enhanced.
19+
placeholder: Describe the motivation or the concrete use case
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: acceptcriterea
24+
attributes:
25+
label: What are the acceptance criteria?
26+
description: List the acceptance criteria for this task in a form of a list.
27+
value: '- [ ]'
28+
- type: textarea
29+
id: additionalinfo
30+
attributes:
31+
label: Additional information
32+
description: If you think that any additional information would be useful please provide them here.
33+
- type: checkboxes
34+
id: terms
35+
attributes:
36+
label: Code of Conduct
37+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/redis-driver/blob/master/CODE_OF_CONDUCT.md)
38+
options:
39+
- label: I agree to follow this project's Code of Conduct
40+
required: true

‎.github/ISSUE_TEMPLATE/4.question.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "❓ Question / Basic Issue"
2+
description: |
3+
Do you have a question on the implementation or a basic issue
4+
labels:
5+
- triage-needed
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: If you are not sure how something works or want discuss something just describe your doubts.
10+
- type: textarea
11+
attributes:
12+
label: What is your question / Please describe your issue
13+
validations:
14+
required: true
15+
- type: input
16+
attributes:
17+
label: What version of Magento 2 Integration are you using?
18+
description: 'For example: 1.0.0'
19+
validations:
20+
required: true
21+
- type: checkboxes
22+
id: terms
23+
attributes:
24+
label: Code of Conduct
25+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/vue-storefront/blob/master/CODE_OF_CONDUCT.md)
26+
options:
27+
- label: I agree to follow this project's Code of Conduct
28+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord Chat
4+
url: https://discord.vuestorefront.io/
5+
about: Ask questions and discuss with other Vue Storefront users in real time.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screenshots (if appropriate):
21+
22+
## Types of changes
23+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
24+
- [ ] Bug fix (non-breaking change which fixes an issue)
25+
- [ ] New feature (non-breaking change which adds functionality)
26+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
27+
28+
## Checklist:
29+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
30+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
31+
- [ ] My code follows the code style of this project.
32+
- [ ] My change requires a change to the documentation.
33+
- [ ] I have updated the documentation accordingly.
34+
- [ ] I have read the **CONTRIBUTING** document.
35+
- [ ] I have added tests to cover my changes.
36+
- [ ] All new and existing tests passed.

‎.github/lock.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Configuration for lock-threads - https://github.com/dessant/lock-threads
2+
# disable lock bot for now
3+
daysUntilLock: 3650
4+
exemptLabels: []
5+
lockLabel: false
6+
lockComment: >
7+
This thread has been automatically locked since there has not been
8+
any recent activity after it was closed. Please open a new issue for
9+
related bugs.

‎.github/stale.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
# daysUntilStale: 60
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
# daysUntilClose: 7
9+
10+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
11+
onlyLabels: []
12+
13+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
14+
# exemptLabels:
15+
# - backlog
16+
17+
# Set to true to ignore issues in a project (defaults to false)
18+
exemptProjects: false
19+
20+
# Set to true to ignore issues in a milestone (defaults to false)
21+
exemptMilestones: false
22+
23+
# Set to true to ignore issues with an assignee (defaults to false)
24+
exemptAssignees: false
25+
26+
# Label to use when marking as stale
27+
staleLabel: wontfix
28+
29+
# Comment to post when marking as stale. Set to `false` to disable
30+
# markComment: >
31+
# This issue has been automatically marked as stale because it has not had
32+
# recent activity. It will be closed if no further activity occurs. Thank you
33+
# for your contributions.
34+
35+
# Comment to post when removing the stale label.
36+
# unmarkComment: >
37+
# Your comment here.
38+
39+
# Comment to post when closing a stale Issue or Pull Request.
40+
# closeComment: >
41+
# Your comment here.
42+
43+
# Limit the number of actions per hour, from 1-30. Default is 30
44+
limitPerRun: 30
45+
46+
# Limit to only `issues` or `pulls`
47+
# only: issues
48+
49+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
50+
pulls:
51+
daysUntilStale: 15
52+
daysUntilClose: 7
53+
markComment: >
54+
This pull request has been automatically marked as stale.
55+
It will be closed if no further activity occurs.
56+
Thank you for your contributions.
57+
58+
issues:
59+
daysUntilStale: 30
60+
daysUntilClose: 7
61+
markComment: >
62+
This issue has been automatically marked as stale.
63+
It will be closed if no further activity occurs.
64+
Thank you for your contributions.
65+
exemptLabels:
66+
- backlog

‎.github/workflows/assing-pr-to-author.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: PR to Author
2+
on:
3+
pull_request:
4+
types: [opened, ready_for_review, edited, synchronize]
5+
6+
jobs:
7+
assignAuthor:
8+
name: Assing
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: samspills/assign-pr-to-author@v1.0
12+
if: github.event_name == 'pull_request' && github.event.action == 'opened'
13+
with:
14+
repo-token: '${{ secrets.GITHUB_TOKEN }}'

0 commit comments

Comments
 (0)