Skip to content

Create templates for issues #390

@b-reyes

Description

@b-reyes

Issue templates are a great way to improve the information we get from individuals who want to contribute to our documentation through issues. I believe we should add these so that creating an issue is simpler. Specifically, I would like to create at least three templates:

  • Content that is not correct
    • The template would ask individuals to provide the page and content that is incorrect and what they believe should be provided.
  • Content that can be improved
    • Ask individuals to provide the page(s) where this content is and state how tehy think it could be improved.
  • Ideas you have for content
    • Ask individuals to provide where they think this would best fit in the documentation and what the structure of this content would look like

Important! When completed, the Contributing to CURC Documentation page should be updated appropriately.

Configuring templates is documented on the GitHub Configuring issue templates for your repository page.

Here is an example of a template I found for sphinx-design. I don't think we should do ours exactly like this, but it gives one a sense of what a template will look like.

Screenshot 2024-11-14 at 10 21 43 AM

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request, lower priority

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions