Skip to content

Commit

Permalink
Merge pull request #670 from NarendraKoya999/ISSUE-TEMPLATES
Browse files Browse the repository at this point in the history
fix: Added styles.yml and documentation.md file for GitHub Issue Templates
  • Loading branch information
agamjotsingh18 authored Aug 3, 2023
2 parents 21889a2 + 8a6865f commit 7769b82
Show file tree
Hide file tree
Showing 2 changed files with 106 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: Documentation Issue
about: Report an issue with the project documentation
title: "[Documentation] "

---

<!--
Please follow the guidelines below to report documentation issues effectively.
-->

### Issue Summary

**Description:**
A clear and concise description of the problem with the documentation or the improvement you'd like to suggest.

**Severity:**
[ ] Low
[ ] Medium
[ ] High
[ ] Critical

**Affected Documentation Section:**
Specify the relevant section(s) or page(s) of the documentation where you encountered the issue.

### Expected Documentation

**Describe the expected content:**
If applicable, describe how you expected the documentation to be, or provide examples of how it could be improved.

**Proposed Solution:**
Share your ideas for improving the documentation or propose a solution if you have one.

### Reproduction Steps

**Steps to Reproduce:**
If the issue is related to inaccuracies or unclear instructions, provide the steps to reproduce the problem.

**Screenshots or Code Snippets:**
Attach any relevant screenshots or code snippets that illustrate the problem.

### Environment Information

**Your Environment:**
- OS: [e.g., Windows, macOS, Linux]
- Browser: [e.g., Chrome, Firefox, Safari]
- Version: [e.g., 1.0.0]

**Additional Context:**
Add any other context or details that might be helpful for understanding the issue.

### Related Documentation URLs

**Links:**
If relevant, provide any specific URLs or links to the documentation in question.

### Additional Notes

**Notes:**
Add any other notes or comments related to this documentation issue.

<!--
Thank you for contributing to our project's documentation!
Please make sure to review our CONTRIBUTING guidelines before submitting your issue.
-->
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/styles.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Style Changing Request
description: Suggest a style designs
title: '[style]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this template!
- type: textarea
id: style-idea
attributes:
label: What's the style idea?
placeholder: Add descriptions
value: 'We need to improve '
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
- label: I have read the [Contributing Guidelines](https://github.com/agamjotsingh18/codesetgo/blob/main/CONTRIBUTING.md)
required: true

- label: I agree to follow this project's [Code of Conduct](https://github.com/agamjotsingh18/codesetgo/blob/main/CODE_OF_CONDUCT.md)
required: true

- label: I'm a GSSoC'23 contributor

- label: I want to work on this issue

0 comments on commit 7769b82

Please sign in to comment.