Skip to content

Commit ec19b4a

Browse files
committed
📝 Add Community Guidelines
1 parent 3d9f2bd commit ec19b4a

File tree

3 files changed

+84
-0
lines changed

3 files changed

+84
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
**Describe the bug**
7+
A clear and concise description of what the bug is.
8+
9+
**To Reproduce**
10+
Steps to reproduce the behavior:
11+
1. Go to '...'
12+
2. Click on '....'
13+
3. Scroll down to '....'
14+
4. See error
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots**
20+
If applicable, add screenshots to help explain your problem.
21+
22+
**Additional context**
23+
Add any other context about the problem here.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
**Is your feature request related to a problem? Please describe.**
7+
A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...]
8+
9+
**Describe the solution you'd like**
10+
A clear and concise description of what you want to happen.
11+
12+
**Describe alternatives you've considered**
13+
A clear and concise description of any alternative solutions or features you've considered.
14+
15+
**Additional context**
16+
Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing
2+
3+
First off, thanks for taking the time to contribute! This is really important to help us improve the library.
4+
5+
## Report bugs
6+
7+
Bugs are reported using [GitHub issues](https://guides.github.com/features/issues/).
8+
9+
Before creating a new issue, [check if your bug hasn't alreaydy been reported](https://github.com/assurance-maladie-digital/vue-cli-plugin-proxy/issues?utf8=%E2%9C%93&q=is%3Aissue). If it's the case and you don't find a solution in the comments, contribute to the issue instead of creating a new one.
10+
11+
### Submit a (good) bug report
12+
13+
Explain the problem and include additional details to help maintainers reproduce the problem:
14+
15+
- **Use a clear and descriptive title**
16+
- **Describe the exact steps which reproduce the problem**
17+
- **Provide specific examples to demonstrate the steps.** Include links to files or projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
18+
19+
<br>
20+
21+
[Go to issues](https://github.com/assurance-maladie-digital/vue-cli-plugin-proxy/issues)
22+
23+
## Suggest changes
24+
25+
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/).
26+
27+
To create enhancement suggestions, [create a new issue](#submitting-a-good-bug-report).
28+
29+
## Code contribution
30+
31+
You can look for issues labelled with `help-wanted` if you're not sure where to start!
32+
33+
#### Commit guidelines
34+
35+
Look at the previous commits for inspiration! But you need it to be explicit, and it should follow these rules:
36+
37+
- Write it in English
38+
- Start with an emoji from [gitmoji](https://gitmoji.carloscuesta.me/) corresponding to the changes made
39+
- Do not end the subject line with a period
40+
- Capitalize the subject line
41+
- Use the imperative mood
42+
43+
#### Pull requests
44+
45+
When creating a pull request, follow and complete the provided template.

0 commit comments

Comments
 (0)