Skip to content

Commit

Permalink
chore: add issue forms, code of conduct and imp changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol-Baranwal committed Nov 11, 2023
1 parent 8bef009 commit 839664e
Show file tree
Hide file tree
Showing 7 changed files with 263 additions and 1 deletion.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: ​🐞 Bug
description: Report an issue to help us improve the workflow.
title: "[BUG] <concise description>"
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A brief description of the issue.
validations:
required: false
- type: input
attributes:
label: Action Version
description: Write verion number in which you are facing bug.
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: Platform?
multiple: false
options:
- Ubuntu
- macOS
- Windows
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CODE_OF_CONDUCT.md)"
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/discussion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Discussion
description: Use this to ask questions and for discussion. Please do not create blank issues.
title: "[Discussion]: <concise title>"
labels: ["status: discussion"]
body:
- type: textarea
id: discussion
attributes:
label: What would you like to discuss or ask?
validations:
required: true
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "Documentation 📋"
description: "Use this form to suggest on how to improve our docs"
title: "[DOCS] <write your suggestion here>"
labels: ["documenation"]

body:
- type: textarea
id: docs_description
attributes:
label: "Issue Description"
description: "Please provide a brief summary of the documentation issue you are experiencing or would like to address."
validations:
required: true

- type: textarea
id: screenshots_examples_docs
attributes:
label: "Screenshots or Examples (if applicable)"
description: "Please include relevant screenshots or examples to help illustrate the problem."

- type: checkboxes
id: terms_checklist_docs
attributes:
label: "Checklist"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CODE_OF_CONDUCT.md)"
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request 💡
description: Have any new idea or new feature to improve the workflow? Please suggest!
title: "[Feature] <write a small description here>"
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the feature.
validations:
required: true
- type: textarea
id: usecase
attributes:
label: Useful Examples
description: Provide an example use case for your suggested feature.
validations:
required: true
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CODE_OF_CONDUCT.md)"
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant 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, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

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

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## 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
[email protected].
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 of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to 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 of time. 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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations# Contributor Covenant Code of Conduct
1 change: 1 addition & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,9 @@ with:

### How to Suggest Features

Feel free to suggest any features or report bugs using these issue templates.
All changes are welcome. Please read our [contributing guidelines](CONTRIBUTING.md)

Feel free to suggest any features or report bugs using these [issue templates](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues/new/choose).

---

Expand Down

0 comments on commit 839664e

Please sign in to comment.