Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Add documentation.md and styles.yml Files Added to ISSUE_TEMPLATES for Future Use #663

Open
4 tasks done
NarendraKoya999 opened this issue Aug 1, 2023 · 1 comment · Fixed by #670
Open
4 tasks done
Assignees

Comments

@NarendraKoya999
Copy link
Contributor

NarendraKoya999 commented Aug 1, 2023

Is your feature request related to a problem? Please describe.

Purpose of Adding these Two Files to GitHub ISSUE TEMPLATES

1. documentation.md (Custom ISSUE_TEMPLATE):

  • The documentation.md file serves as a custom ISSUE_TEMPLATE for your GitHub repository, specifically focused on documentation-related issues. When contributors or users of your project want to report documentation-related problems, improvements, or requests, they can create a new issue using this template.

  • The contents of documentation.md could include prompts or guidelines to help users structure their documentation-related issue reports effectively. For example, it might ask them to provide specific details about the section/page of documentation they found confusing, suggest possible improvements, or even ask for clarifications about the issue they are experiencing.

2. styles.yml (Custom ISSUE_TEMPLATE):

  • The styles.yml file, on the other hand, serves as a custom ISSUE_TEMPLATE for issues related to coding style, code formatting, and linting rules within your GitHub repository. This template helps contributors or users report code style-related concerns or seek guidance on adhering to the project's coding standards.

  • The contents of styles.yml might include specific questions or prompts related to coding style, requesting users to provide examples of code snippets that need formatting adjustments or explanation. Additionally, you might include instructions on how to check code against the project's style guidelines and best practices.

Describe the solution you'd like.

  • Adding those above Two Files documentation.md and style.yml Files are Very Useful for Documentation Updates , Modifications and for styling point of View, Raising ther Only Enhancement related Issues.

Describe alternatives you've considered.

No Alternatives

Add any other context or screenshots about the feature request here.

No response

Record

  • I agree to follow this project's Code of Conduct
  • I have checked the existing issues
  • I'm a GSSoC'23 contributor
  • I want to work on this issue
@agamjotsingh18
Copy link
Owner

Sure @NarendraKoya999

@NarendraKoya999 NarendraKoya999 changed the title [Feature]: Add documentation.yml and style.yml Files Added to ISSUE_TEMPLATES for Future Use [Feature]: Add documentation.md and styles.yml Files Added to ISSUE_TEMPLATES for Future Use Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants