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

Added default issue template. #165

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Viddesh1
Copy link

No description provided.

@Viddesh1
Copy link
Author

@microsoft-github-policy-service agree

@l-lumin
Copy link
Contributor

l-lumin commented Dec 20, 2024

I think you should spend some time to modifying the issue templates to suit this repository rather than using the default

@Viddesh1
Copy link
Author

Hello @l-lumin ,

Thanks for checking the pull request.

Currently, I am not really sure what would be the best Issue template format for this project.

Below are some of the issue templates that took a glance:-

https://github.com/microsoft/TypeScript/issues/new?template=bug_report.yml
https://github.com/microsoft/vscode/issues/new?template=feature_request.md
https://github.com/microsoft/RD-Agent/issues/new?template=bug-report.md
https://github.com/microsoft/debugpy/issues/new?template=bug_report.md
https://github.com/microsoft/pyright/issues/new?template=bug_report.md

Different repository have either markdown and form based issue template fine tuned to specific requirements for respective projects.

Below are the points thatIi think they have in common which included in the issue template issue and pull request template.

  1. https://github.com/microsoft/markitdown/blob/main/README.md
  2. https://github.com/microsoft/markitdown/blob/main/SUPPORT.md
  3. https://github.com/microsoft/markitdown/blob/main/SECURITY.md
  4. https://github.com/microsoft/markitdown/blob/main/CODE_OF_CONDUCT.md
  5. Please search existing issues or pull request to avoid creating duplicates.

Regards!
Viddesh

@l-lumin
Copy link
Contributor

l-lumin commented Dec 20, 2024

I think for the issue templates, we should start with two types:

  • for feature requests, such as adding support for a new file format (and maybe including a sample file)
  • for bug reports, which should include details like the problem description, steps to reproduce, additional information like the version, and the file

- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
Copy link
Contributor

Choose a reason for hiding this comment

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

remove smartphone. combine with desktop

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for comment. I removed the smartphone information and removed extra space in between.

Viddesh1 and others added 2 commits December 21, 2024 11:35
"""
**Smartphone (please complete the following information):**
 - Device: [e.g. iPhone6]
 - OS: [e.g. iOS8.1]
 - Browser [e.g. stock browser, safari]
 - Version [e.g. 22]
"""
And removed extra new lines between desktop and additional context.
@gagb
Copy link
Contributor

gagb commented Dec 21, 2024

Is there a reason you used md instead of YAML? https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

We should keep the issue template really concise.

@Viddesh1
Copy link
Author

Hello @gagb ,

The reason is simplicity.
Markdown provides simplicity to us to update issue template and issue creator using md template to update the issue or feature request. Also, if they want they can update the template specific to creating the issues add or subtract specific information.

YAML form based issue templates is also good. Since it is form based issue creator can add the specific information that they want in specific form based fields. It would also make sure that all the fields are filled with some information and no fields are empty. If we want concise information then we can go with YAML.

Which one do you prefer?

Thanks!
Viddesh

@gagb gagb self-requested a review December 23, 2024 02:39
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

Successfully merging this pull request may close these issues.

3 participants