Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Raj-banerjee25 committed Nov 2, 2024
2 parents 5f14887 + af8bf07 commit 30ae2ba
Show file tree
Hide file tree
Showing 30 changed files with 3,501 additions and 1,094 deletions.
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/Custom.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: "⚙️ Custom Issue"
description: "Submit a custom issue or suggestion for Canvas-Editor."
title: "[Custom]: <Brief description of the issue>"
labels: ["custom", "status: needs triage"]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a custom issue for **Canvas-Editor**! This template is intended for any requests or suggestions that don't fit into the bug report, feature request, or documentation categories.
- type: input
id: issue_summary
attributes:
label: "Issue Summary"
description: "Provide a summary of the custom issue."
placeholder: "E.g., Enhancement suggestion for search functionality"
validations:
required: true

- type: textarea
id: issue_description
attributes:
label: "Issue Description"
description: "Describe the issue or suggestion in detail."
placeholder: "Provide a detailed description of the custom issue, including the context, use case, or scenario in which this issue occurs or would be relevant..."
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: "Proposed Solution (Optional)"
description: "If you have any ideas or suggestions for how to address this issue, describe them here."
placeholder: "Describe your proposed solution or approach..."

- type: dropdown
id: priority
attributes:
label: "Priority"
description: "How important is this issue to you?"
options:
- "High - Requires urgent attention"
- "Medium - Should be addressed soon"
- "Low - Can be addressed later"
validations:
required: true

- type: checkboxes
id: category
attributes:
label: "Category"
description: "Select the category that best describes the issue."
options:
- label: "Enhancement"
- label: "Refactor"
- label: "Security"
- label: "Design"
- label: "Other"

- type: textarea
id: additional_context
attributes:
label: "Additional Context (Optional)"
description: "Add any other context or information that might be relevant to this issue."
placeholder: "Provide any extra details, screenshots, or references that could help with understanding the issue..."

- type: markdown
attributes:
value: |
**Thank you for your suggestion!** We appreciate your input and will review your custom issue promptly. 📝
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: ​🐞 Bug
description: Report an issue to help us improve the project.
title: '[BUG] '
labels: ["bug"]
body:
- type: textarea
attributes:
label: Description
id: description
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
validations:
required: false
- type: textarea
attributes:
label: Screenshots
id: screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
attributes:
label: Any additional information?
id: extrainfo
description: Any additional information or Is there anything we should know about this bug?
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: What browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: checkboxes
id: no-duplicate-issues
attributes:
label: 'Checklist'
options:
- label: 'I have checked the existing issues'
required: true

- label: 'I have read the [Contributing Guidelines](https://github.com/alo7lika/Canvas-Editor/blob/dev/Contributing.md)'
required: true
- label: "I'm a GSSoC'24-Extd contributor"
- label: "I'm a Hacktoberfest'24 contributor"

- label: 'I am willing to work on this issue (optional)'
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Questions or need suggestions?
url: https://github.com/vishanurag/Canvas-Editor/discussions/new?category=q-a
about: You can create a Q&A discussion and ask for clarifications
- name: Guidelines
url: https://github.com/vishanurag/Canvas-Editor/blob/main/Contributing.md
about: Before opening a new issue, please make sure to read CONTRIBUTING.md
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: 📝 Documentation Update
description: Improve Documentation
title: "[Doc]: "
labels: [documentation]
body:
- type: checkboxes
id: existing-issue
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the updates you want to make.
options:
- label: I have searched the existing issues
required: true

- type: textarea
id: issue-description
attributes:
label: Issue Description
description: Please provide a clear description of the documentation update you are suggesting.
placeholder: Describe the improvement or correction you'd like to see in the documentation.
validations:
required: true

- type: textarea
id: suggested-change
attributes:
label: Suggested Change
description: Provide details of the proposed change to the documentation.
placeholder: Explain how the documentation should be updated or corrected.
validations:
required: true

- type: textarea
id: rationale
attributes:
label: Rationale
description: Why is this documentation update necessary or beneficial?
placeholder: Explain the importance or reasoning behind the suggested change.
validations:
required: false

- type: dropdown
id: urgency
attributes:
label: Urgency
description: How urgently do you believe this documentation update is needed?
options:
- High
- Medium
- Low
default: 0
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: Acknowledgements
description: Ensure you have read and agree to the project's guidelines.
options:
- label: I have read the [Contributing Guidelines](https://github.com/alo7lika/Canvas-Editor/blob/dev/Contributing.md)
required: true
- label: I'm a GSSOC'24-Extd contributor
- label: I'm a Hacktoberfest contributor
- label: I have starred the repository
required: true
- label: 'I am willing to work on this issue (optional)'
required: false



65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Enhancement Request 🧑‍💻
description: Submit your enhancement requests for review.
title: '🧑‍💻: '
labels: ["Up-for-Grabs ✋", "enhancement 🧑‍💻"]
assignees:
- ''

body:
- type: textarea
id: enhancement-title
attributes:
label: Title
placeholder: Enter the title of your enhancement request here.
validations:
required: true

- type: textarea
id: enhancement-aim
attributes:
label: Enhancement Aim
placeholder: Describe the aim of the enhancement.
validations:
required: true

- type: textarea
id: changes
attributes:
label: Changes
placeholder: Enlist those changes you want to make.
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots 📷
placeholder: Write N/A if not available.
validations:
required: false

- type: checkboxes
id: guidelines
attributes:
label: Guidelines
options:
- label: "I have read the guidelines"
required: true
- label: "I have the link to my latest merged PR"
required: false

- type: textarea
id: full-name
attributes:
label: Full Name
placeholder: Enter your full name here.
validations:
required: true

- type: textarea
id: participant-role
attributes:
label: Participant Role
placeholder: Enter your participant role here (e.g., GSOC, GSSOC).
validations:
required: true
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: "✨ Feature Request"
description: "Suggest any new feature / functionality which will actually be a meaningful addon to the application."
title: "Feat:"
labels: [Feat, Needs Triage]
body:
- type: checkboxes
attributes:
label: "Is there an existing issue raised for this?"
description: "Before reporting, kindly ensure that you dont duplicate an already existing issue."
options:
- label: "I have searched the existing issues"
required: true
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe the new feature you are suggesting. Try to be as much detailed as possible.
- type: textarea
attributes:
label: Describe the feature
description: Describe your idea which you would like to implement. Add necessary prototypes or rough sketch or an overview on how you will be proceeding with this request. A breif about the approach, tools or libraries you will be using will be an add-on.
placeholder: Eg - Adding chat functionality, integrating Google sign on etc
validations:
required: true
- type: textarea
attributes:
label: "Add ScreenShots"
description: "Add sufficient SS to explain your issue."
validations:
required: true
- type: textarea
attributes:
label: Component
description: Where would you like to add this feature? specify the URI if you want to add a new feature in an existing URI.
placeholder: Eg - /navbar
validations:
required: true
- type: textarea
attributes:
label: It should be implemented because
description: Give out a detailed explanation along with its use-case
validations:
required: true
- type: dropdown
id: assign
attributes:
label: "Would you like to work on this issue?"
options:
- "Yes"
- type: checkboxes
attributes:
label: "Terms & Conditions"
options:
- label: "I agree to follow the Code of Conduct"
required: true
- label: "I'm a GSSOC'24 Ext contributor"
- type: markdown
attributes:
value: |
Thanks for your suggestion! Let's see together if it can be implemented.
31 changes: 31 additions & 0 deletions .github/workflows/auto-comment-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Issue Opened and Closed Comment

on:
issues:
types: [opened, closed]

jobs:
comment-on-issue:
runs-on: ubuntu-latest

steps:
- name: Check out the repository
uses: actions/checkout@v2

- name: Comment on Issue Opened
if: ${{ github.event.action == 'opened' }}
uses: actions-ecosystem/action-create-comment@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
issue_number: ${{ github.event.issue.number }}
body: |
Thanks for opening this issue! We appreciate your contribution. Please make sure you’ve provided all the necessary details and screenshots, and don't forget to follow our [Guidelines](https://github.com/OWNER/REPO/CONTRIBUTING.md) and Code of Conduct. Happy coding! 🚀
- name: Comment on Issue Closed
if: ${{ github.event.action == 'closed' }}
uses: actions-ecosystem/action-create-comment@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
issue_number: ${{ github.event.issue.number }}
body: |
This issue has been successfully closed. Thank you for your contribution and helping us improve the project! If you have any more ideas or run into other issues, feel free to open a new one. Happy coding! 🚀
22 changes: 22 additions & 0 deletions .github/workflows/auto-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Auto-label Issues and Pull Requests

on:
issues:
types: [opened]
pull_request:
types: [opened]

jobs:
add-labels:
runs-on: ubuntu-latest

steps:
- name: Check out the repository
uses: actions/checkout@v2

- name: Add Labels to Issue or Pull Request
uses: actions-ecosystem/action-add-labels@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
labels: "gssoc-ext, hacktoberfest-accepted"
issue_number: ${{ github.event.issue.number || github.event.pull_request.number }}
Loading

0 comments on commit 30ae2ba

Please sign in to comment.