Skip to content

Commit a7b028b

Browse files
sebastienfisebastienfi
committed
chores: Add various config including templates
1 parent f54ae02 commit a7b028b

7 files changed

+413
-0
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @sebastienfi

‎.github/CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
11+
- Demonstrating empathy and kindness toward other people
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Giving and gracefully accepting constructive feedback
14+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
15+
- Focusing on what is best not just for us as individuals, but for the overall community
16+
17+
Examples of unacceptable behavior include:
18+
19+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
20+
- Trolling, insulting or derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Enforcement Responsibilities
26+
27+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
28+
29+
## Scope
30+
31+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
32+
33+
## Enforcement
34+
35+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [Your Contact Email]. All complaints will be reviewed and investigated promptly and fairly.
36+
37+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
38+
39+
## Enforcement Guidelines
40+
41+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
42+
43+
### 1. Correction
44+
45+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
46+
47+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
48+
49+
### 2. Warning
50+
51+
**Community Impact**: A violation through a single incident or series of actions.
52+
53+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period. This includes avoiding interactions in community spaces as well as external channels like social media. Failing to follow these guidelines may result in a temporary or permanent ban.
54+
55+
### 3. Temporary Ban
56+
57+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
58+
59+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
60+
61+
### 4. Permanent Ban
62+
63+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
64+
65+
**Consequence**: A permanent ban from any sort of public interaction within the community.
66+
67+
## Attribution
68+
69+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
70+
71+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Complaints can be sent to [Your Contact Email].

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Bug Report
2+
description: File a report to help us improve
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
assignees:
6+
- sebastienfi
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to report a bug. Please provide as much information as possible to help us understand and resolve the issue.
13+
14+
- type: input
15+
id: what-happened
16+
attributes:
17+
label: What happened?
18+
description: A clear and concise description of what the bug is.
19+
placeholder: Tell us what you found...
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: reproduction-steps
25+
attributes:
26+
label: Steps to reproduce
27+
description: Steps to reproduce the behavior.
28+
placeholder: |
29+
1. Go to '...'
30+
2. Click on '....'
31+
3. Scroll down to '....'
32+
4. See error
33+
validations:
34+
required: true
35+
36+
- type: input
37+
id: expected-behavior
38+
attributes:
39+
label: Expected behavior
40+
description: A clear and concise description of what you expected to happen.
41+
placeholder: I expected...
42+
validations:
43+
required: true
44+
45+
- type: dropdown
46+
id: severity
47+
attributes:
48+
label: Severity
49+
description: How severe is the bug?
50+
options:
51+
- Critical - System crash, loss of data, severe memory leak.
52+
- High - Major functionality is broken, the system is unusable in some scenarios.
53+
- Medium - Minor functionality is not working as expected.
54+
- Low - Cosmetic issues, minor inconveniences.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: additional-context
60+
attributes:
61+
label: Additional context
62+
description: Add any other context about the problem here.
63+
placeholder: Add any other context or screenshots about the bug report here.
64+
65+
- type: checkboxes
66+
id: terms
67+
attributes:
68+
label: Code of Conduct
69+
description: By submitting this issue, I confirm I've read and acknowledge the [Code of Conduct](../CODE_OF_CONDUCT.md).
70+
options:
71+
- label: I agree to follow this project's Code of Conduct
72+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FEATURE REQUEST] "
4+
labels: ["enhancement"]
5+
assignees:
6+
- sebastienfi
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to suggest a feature! Please fill out the details below to help us understand your proposal.
13+
14+
- type: input
15+
id: feature-summary
16+
attributes:
17+
label: Feature Summary
18+
description: A brief summary of the feature.
19+
placeholder: A concise summary of what you're proposing...
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: feature-description
25+
attributes:
26+
label: Detailed Description
27+
description: Describe the feature in detail. Include any specific requirements or functionality.
28+
placeholder: |
29+
Describe your feature in detail here...
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: motivation-benefits
35+
attributes:
36+
label: Motivation and Benefits
37+
description: Explain why this feature is valuable to the project and its users.
38+
placeholder: |
39+
Why is this feature important? Who will benefit from it?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: possible-implementation
45+
attributes:
46+
label: Possible Implementation
47+
description: Suggestions for how this feature might be implemented, if you have ideas.
48+
placeholder: |
49+
If you have ideas about how the feature could be implemented, share them here...
50+
validations:
51+
required: false
52+
53+
- type: checkboxes
54+
id: terms
55+
attributes:
56+
label: Code of Conduct
57+
description: By submitting this feature request, I confirm I've read and acknowledge the [Code of Conduct](../CODE_OF_CONDUCT.md).
58+
options:
59+
- label: I agree to follow this project's Code of Conduct
60+
required: true

‎.github/issue_label_bot.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label-alias:
2+
bug: 'Type: Bug'
3+
feature_request: 'Type: Feature'
4+
question: 'Type: Question'

‎.github/pull_request_template.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Description of Changes
2+
3+
Please provide a brief summary of the changes you've made. Include any relevant issue numbers.
4+
5+
## Tests
6+
7+
Detail any new or updated tests that were created for these changes.
8+
9+
## Documentation
10+
11+
Describe any documentation changes or additions that need to be made as a result of your changes.
12+
13+
## Acknowledgements
14+
15+
- [ ] I have followed the guidelines in the CONTRIBUTING document.
16+
- [ ] My code follows the code style of this project.
17+
- [ ] My change requires a change to the documentation, and I have updated it accordingly.

0 commit comments

Comments
 (0)