Skip to content

Commit c6b7862

Browse files
committed
chore: github templates
1 parent 3e552bc commit c6b7862

File tree

9 files changed

+146
-3
lines changed

9 files changed

+146
-3
lines changed

.github/CODE_OF_CONDUCT.md

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

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: vueform

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: "\U0001F41E Bug report"
2+
description: Create a report to help us improve Vueform
3+
labels: ["pending triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please carefully read the contribution docs before creating a bug report
9+
👉 https://vueform.com/community/reporting-bugs
10+
11+
Please use a template below to create a minimal reproduction
12+
👉 https://stackblitz.com/github/vueform/sandbox
13+
- type: textarea
14+
id: bug-env
15+
attributes:
16+
label: Environment
17+
description: Please list **framework with version** (Vite 4.5.0, Nuxt 3.7.4, etc.), the theme (vueform/tailwind/etc) and the **package manager** (npm/yarn/pnpm/bun)
18+
placeholder: Environment
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduction
23+
attributes:
24+
label: Reproduction
25+
description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://stackblitz.com/github/vueform/sandbox) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it.
26+
placeholder: Reproduction
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: bug-description
31+
attributes:
32+
label: Describe the bug
33+
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
34+
placeholder: Bug description
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: additonal
39+
attributes:
40+
label: Additional context
41+
description: If applicable, add any other context about the problem here
42+
- type: textarea
43+
id: logs
44+
attributes:
45+
label: Logs
46+
description: |
47+
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
48+
render: shell-script

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ❓ Ask a Question
4+
url: https://github.com/vueform/vueform/discussions/categories/questions
5+
about: Not sure about something? Start a "New discussion" and get an answer
6+
- name: 💡 Feature Idea
7+
url: https://github.com/vueform/vueform/discussions/categories/ideas
8+
about: Suggest a feature that will improve Vueform by starting a "New discussion"
9+
- name: 📚 Learning Guide
10+
url: https://vueform.com/docs/input-mask
11+
about: Learning material for Vueform

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!---
2+
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
3+
4+
Please carefully read the contribution docs before creating a pull request
5+
👉 https://vueform.com/community/contribution-guide
6+
-->
7+
8+
### 🔗 Linked issue
9+
10+
<!-- Please ensure there is an open issue and mention its number as #123 -->
11+
12+
### ❓ Type of change
13+
14+
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
15+
16+
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
17+
- [ ] 👌 Enhancement (improving an existing functionality like performance)
18+
- [ ] ✨ New feature (a non-breaking change that adds functionality)
19+
- [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
20+
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
21+
22+
### 📚 Description
23+
24+
<!-- Describe your changes in detail -->
25+
<!-- Why is this change required? What problem does it solve? -->
26+
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->
27+
28+
### 📝 Checklist
29+
30+
<!-- Put an `x` in all the boxes that apply. -->
31+
<!-- If your change requires a documentation PR, please link it appropriately -->
32+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
33+
34+
- [ ] I have linked an issue or discussion.
File renamed without changes.
File renamed without changes.

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ node_modules/
1212
tests/
1313
.gitignore
1414
babel.config.js
15-
CODE_OF_CONDUCT.md
15+
CODE_OF_CONDUCT.md
16+
.github/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<a href="https://vueform.com?cid=plugin-mask">
22
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/vueform/plugin-mask/raw/main/assets/logo-dark.svg">
4-
<img alt="Vueform Logo" src="https://github.com/vueform/plugin-mask/raw/main/assets/logo.svg">
3+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/vueform/plugin-mask/raw/main/.github/assets/logo-dark.svg">
4+
<img alt="Vueform Logo" src="https://github.com/vueform/plugin-mask/raw/main/.github/assets/logo.svg">
55
</picture>
66
</a>
77

0 commit comments

Comments
 (0)