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

[Issue#15] Add ISSUE template #38

Merged
merged 5 commits into from
Nov 21, 2023
Merged

Conversation

KarolinaZakrzewska
Copy link
Collaborator

@KarolinaZakrzewska KarolinaZakrzewska commented Nov 11, 2023

Resolves #15

Scope of changes

The added templates will be used when creating new issues. If you need a new template, create a new request issue based on feature_ request.md.

  • added a .github file with the ISSUE_TEMPLATE internal file
  • added 3 template files:
    documentation_fix.md
    feature_request.md
    problem_report.md

When we add it to main PR, the templates will be available.

How to use

  1. select the problems tab
  2. create a new issue
  3. select template
  4. complete the template

obraz

@KarolinaZakrzewska
Copy link
Collaborator Author

Tomorrow I will add information on how it works. I need to test the configuration instructions from https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.

@KarolinaZakrzewska KarolinaZakrzewska self-assigned this Nov 11, 2023
@KarolinaZakrzewska KarolinaZakrzewska added the documentation Improvements or additions to documentation label Nov 11, 2023
bugITwhisperer

This comment was marked as duplicate.

Copy link
Collaborator

@bugITwhisperer bugITwhisperer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :) but not sure whether we need all of 3 issue templates

@KarolinaZakrzewska
Copy link
Collaborator Author

LGTM :) but not sure whether we need all of 3 issue templates

In my opinion we can have 2 templates:
one for problem_report
and one universal for feature_request & problem_report.

I didn't think about the test template, e.g. #25. Do we need any template for this?

@KarolinaZakrzewska
Copy link
Collaborator Author

Tomorrow I will add information on how it works. I need to test the configuration instructions from https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.

I added instructions for use.

@KarolinaZakrzewska
Copy link
Collaborator Author

KarolinaZakrzewska commented Nov 12, 2023

I added suggestions for a universal template. We can talk about it tomorrow. 😄

@KarolinaZakrzewska KarolinaZakrzewska added the to be decided This has to be discussed label Nov 12, 2023
@KarolinaZakrzewska KarolinaZakrzewska added GitHub-process-flow GitHub process-related and removed documentation Improvements or additions to documentation labels Nov 13, 2023
Copy link
Owner

@kat-kan kat-kan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we decide on more than one template, please add to them:

  • request to check existing issues
  • request to add labels
  • request to assign to someone or add help-wanted label

@KarolinaZakrzewska KarolinaZakrzewska removed the to be decided This has to be discussed label Nov 19, 2023
@KarolinaZakrzewska
Copy link
Collaborator Author

I updated the templates as agreed during the meeting.

@KarolinaZakrzewska KarolinaZakrzewska merged commit 6c9496d into main Nov 21, 2023
@bugITwhisperer bugITwhisperer deleted the docs/ISSUE-15_issue_template branch November 24, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GitHub-process-flow GitHub process-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[GitHub Project] Add ISSUE template
4 participants