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

[Feat]: Add styles.yml and documentation.yml for GitHub Issue Templates #409

Closed
3 tasks done
NarendraKoya999 opened this issue Aug 2, 2023 · 3 comments
Closed
3 tasks done

Comments

@NarendraKoya999
Copy link

What feature?

documentation.yml (Custom ISSUE_TEMPLATE):

  • The documentation.yml 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.yml 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.

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.

Show us the magic with screenshots

No response

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSoC'23 contributor
  • I want to work on this issue
@github-actions
Copy link

github-actions bot commented Aug 2, 2023

Hey @NarendraKoya999,

Thank you for raising an issue. We will investigate into the matter and get back to you as soon as possible.

Please make sure you have given us as much context as possible.

@swapnilsparsh
Copy link
Owner

@NarendraKoya999 Not required.

@github-actions
Copy link

github-actions bot commented Aug 3, 2023

Hey @NarendraKoya999, This issue is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants