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

Commit 029f4de

Browse files
committed
refactor: added github missing documentation and config
1 parent 2ffbd54 commit 029f4de

File tree

4 files changed

+161
-0
lines changed

4 files changed

+161
-0
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/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

0 commit comments

Comments
 (0)