Skip to content

Commit df70148

Browse files
webdevnerdstuffwebdevnerdstuff
authored
Merge pull request #1 from webdevnerdstuff/dev
Dev
2 parents c0c9a07 + ca5fef9 commit df70148

File tree

6 files changed

+259
-0
lines changed

6 files changed

+259
-0
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Contributing to this repository <!-- omit in toc -->
2+
3+
## Getting started <!-- omit in toc -->
4+
5+
Before you begin:
6+
- Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
7+
- Check out the [existing issues](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues).
8+
9+
### Don't see your issue? Open one
10+
11+
If you spot something new, open an issue using a [template](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
12+
13+
### Ready to make a change? Fork the repo
14+
15+
Fork using the command line:
16+
17+
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
18+
19+
### Make your update:
20+
21+
Make your changes to the file(s) you'd like to update.
22+
Update the CHANGELOG.md with the updates you made, please include the date and Github username.
23+
24+
### Open a pull request
25+
When you're done making changes and you'd like to propose them for review, open your PR (pull request).
26+
27+
### Submit your PR & get it reviewed
28+
- Once you submit your PR, others from the Vue Unicorn Log community will review it with you.
29+
- After that, we may have questions, check back on your PR to keep up with the conversation.
30+
31+
### Your PR is merged!
32+
Congratulations! The whole GitHub community thanks you. :sparkles:
33+
34+
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vuetify-stepper-form/graphs/contributors).
35+
36+
### Keep contributing as you use Vue Unicorn Log
37+
38+
Now that you're a part of the Vue Unicorn Log community, you can keep participating in many ways.
39+
40+
## Types of contributions
41+
You can contribute to the Vue Unicorn Log content and site in several ways. This repo is a place to discuss and collaborate on Vue Unicorn Log! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
42+
43+
### :mega: Discussions
44+
Discussions are where we have conversations.
45+
46+
If you'd like help troubleshooting a Vue Unicorn Log PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vuetify-stepper-form/discussions).
47+
48+
### :beetle: Issues
49+
[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
50+
51+
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
52+
53+
### :hammer_and_wrench: Pull requests
54+
A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository.
55+
56+
To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below.
57+
58+
### :question: Support
59+
We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked.
60+
61+
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
62+
63+
## Starting with an issue
64+
You can browse existing issues to find something that needs help!
65+
66+
### Labels
67+
Labels can help you find an issue you'd like to help with.
68+
69+
- The [`help wanted` label](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on.
70+
- The [`documentation` label](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation.
71+
- The [`bug` label](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs.
72+
- The [`enhancement` label](https://github.com/webdevnerdstuff/vuetify-stepper-form/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
73+
suggestions to improve the code or adding of additional features.
74+
75+
## Opening a pull request
76+
You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
77+
78+
## Working in the Vue Unicorn Log repository
79+
Here's some information that might be helpful while working on a Vue Unicorn Log PR:
80+
81+
<!-- - [Development](/contributing/development.md) - This short guide describes how to get this app running on your local machine. -->
82+
83+
## Reviewing
84+
We (usually the Vue Unicorn Log team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
85+
86+
- Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
87+
- Reviews discuss content, not the person who created it.
88+
- Reviews are constructive and start conversation around feedback.
89+
90+
### Self review
91+
You should always review your own PR first.
92+
93+
<!-- ### Pull request template
94+
When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. -->
95+
96+
### Suggested changes
97+
We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
98+
99+
As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).

‎.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
custom: ["paypal.me/webdevnerdstuff"]
2+
patreon: webdevnerdstuff

‎.github/ISSUE_TEMPLATE/BUG_REPORT.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
assignees:
6+
- webdevnerdstuff
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: textarea
13+
id: bug-description
14+
attributes:
15+
label: Bug description
16+
description: What happened?
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: steps
21+
attributes:
22+
label: Steps to reproduce
23+
description: Which steps do we need to take to reproduce this error?
24+
placeholder: "Steps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'"
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: logs
29+
attributes:
30+
label: Relevant log output
31+
description: If applicable, please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
32+
render: shell
33+
- type: input
34+
id: reproduction
35+
attributes:
36+
label: Reproduction link
37+
description: Please only use [StackBlitz](https://stackblitz.com/), [CodeSandbox](https://codesandbox.io/s/vue) or a github repo. Issues submitted without a reproduction link will be closed.
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: additional-context
42+
attributes:
43+
label: Additional context
44+
description: Add any other context about the problem here.
45+
- type: checkboxes
46+
id: terms
47+
attributes:
48+
label: Code of Conduct
49+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdevnerdstuff/vuetify-stepper-form/blob/main/CODE_OF_CONDUCT.md)
50+
options:
51+
- label: I agree to follow this project's Code of Conduct
52+
required: true

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature Request]: "
4+
labels: ["feature request"]
5+
assignees:
6+
- webdevnerdstuff
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this request!
12+
- type: textarea
13+
id: related-to-a-problem
14+
attributes:
15+
label: Is your feature request related to a problem? Please describe.
16+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: feature-desc
21+
attributes:
22+
label: Describe the solution you'd like
23+
description: A clear and concise description of what you want to happen.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: A clear and concise description of any alternative solutions or features you've considered.
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: additional-context
35+
attributes:
36+
label: Additional context
37+
description: Add any other context about the problem here.
38+
- type: checkboxes
39+
id: terms
40+
attributes:
41+
label: Code of Conduct
42+
description: By submitting this request, you agree to follow our [Code of Conduct](https://github.com/webdevnerdstuff/vuetify-stepper-form/blob/main/CODE_OF_CONDUCT.md)
43+
options:
44+
- label: I agree to follow this project's Code of Conduct
45+
required: true

‎.github/workflows/inactive-issues.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Close inactive issues
2+
on:
3+
schedule:
4+
- cron: "30 1 * * *"
5+
6+
jobs:
7+
close-issues:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/stale@v3
11+
with:
12+
days-before-issue-stale: 30
13+
days-before-issue-close: 14
14+
stale-issue-label: "stale"
15+
stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
16+
close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
17+
days-before-pr-stale: -1
18+
days-before-pr-close: -1
19+
repo-token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/main.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Deploy to GitHub Pages
3+
4+
on:
5+
push:
6+
branches: [ main ]
7+
8+
permissions:
9+
contents: write
10+
pages: write
11+
id-token: write
12+
pull-requests: write
13+
repository-projects: write
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
19+
strategy:
20+
matrix:
21+
node-version: [19]
22+
23+
steps:
24+
- uses: actions/checkout@v3
25+
26+
- name: Use Node.js ${{ matrix.node-version }}
27+
uses: actions/setup-node@v3
28+
with:
29+
node-version: ${{ matrix.node-version }}
30+
31+
- name: Build
32+
run: |
33+
git config --global user.email "[email protected]"
34+
git config --global user.name "WebDevNerdStuff"
35+
mkdir docs
36+
npm install --g gh-pages
37+
npm i
38+
npm run build:docs
39+
git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
40+
npm run deploy -u "github-actions-bot <[email protected]>"
41+
env:
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)