Skip to content

Commit

Permalink
chores: Add various config including templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienfi committed Dec 29, 2023
1 parent 4646ff7 commit 65219cd
Show file tree
Hide file tree
Showing 7 changed files with 413 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @sebastienfi
75 changes: 75 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Code of Conduct

## Our Pledge

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.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

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.

## Scope

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.

## Enforcement

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.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**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.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**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.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**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.

### 4. Permanent Ban

**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.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

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).

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

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].
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug Report
description: File a report to help us improve
title: "[BUG] "
labels: ["bug"]
assignees:
- sebastienfi

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug. Please provide as much information as possible to help us understand and resolve the issue.
- type: input
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
placeholder: Tell us what you found...
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: input
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: I expected...
validations:
required: true

- type: dropdown
id: severity
attributes:
label: Severity
description: How severe is the bug?
options:
- Critical - System crash, loss of data, severe memory leak.
- High - Major functionality is broken, the system is unusable in some scenarios.
- Medium - Minor functionality is not working as expected.
- Low - Cosmetic issues, minor inconveniences.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder: Add any other context or screenshots about the bug report here.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, I confirm I've read and acknowledge the [Code of Conduct](../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Feature Request
description: Suggest an idea for this project
title: "[FEATURE REQUEST] "
labels: ["enhancement"]
assignees:
- sebastienfi

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature! Please fill out the details below to help us understand your proposal.
- type: input
id: feature-summary
attributes:
label: Feature Summary
description: A brief summary of the feature.
placeholder: A concise summary of what you're proposing...
validations:
required: true

- type: textarea
id: feature-description
attributes:
label: Detailed Description
description: Describe the feature in detail. Include any specific requirements or functionality.
placeholder: |
Describe your feature in detail here...
validations:
required: true

- type: textarea
id: motivation-benefits
attributes:
label: Motivation and Benefits
description: Explain why this feature is valuable to the project and its users.
placeholder: |
Why is this feature important? Who will benefit from it?
validations:
required: true

- type: textarea
id: possible-implementation
attributes:
label: Possible Implementation
description: Suggestions for how this feature might be implemented, if you have ideas.
placeholder: |
If you have ideas about how the feature could be implemented, share them here...
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this feature request, I confirm I've read and acknowledge the [Code of Conduct](../CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
4 changes: 4 additions & 0 deletions .github/issue_label_bot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
label-alias:
bug: 'Type: Bug'
feature_request: 'Type: Feature'
question: 'Type: Question'
17 changes: 17 additions & 0 deletions .github/pull_request_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Description of Changes

Please provide a brief summary of the changes you've made. Include any relevant issue numbers.

## Tests

Detail any new or updated tests that were created for these changes.

## Documentation

Describe any documentation changes or additions that need to be made as a result of your changes.

## Acknowledgements

- [ ] I have followed the guidelines in the CONTRIBUTING document.
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation, and I have updated it accordingly.
Loading

0 comments on commit 65219cd

Please sign in to comment.