Skip to content

chore: revisited issue & PR templates #1336

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

Merged
merged 1 commit into from
Feb 26, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR revisits the templates for Issues and PR and once merged resolves #1331.

The changes made to the templates are the following:

  • Changed rendering of code snippet in bug report to markdown, so that users can also add text or multiple code snippets
  • Added placeholder texts to bug report to help users filling the form
  • Added Discord link to issue type choice screen
  • Added .NET link to all applicable issues
  • Added new input field that whose value will be attached at the bottom of the issue and rendered (see screenshot below)
  • Updated PR template to remove PR Status section, we can achieve the same with drafts & review requests

How to verify this change

Example of rendered text:
image

Related issues, RFCs

Issue number: #1331

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi linked an issue Feb 26, 2023 that may be closed by this pull request
2 tasks
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Feb 26, 2023
@dreamorosi dreamorosi self-assigned this Feb 26, 2023
@dreamorosi dreamorosi merged commit 4c002e5 into main Feb 26, 2023
@dreamorosi dreamorosi deleted the 1331-maintenance-revisit-issue-forms branch February 26, 2023 15:51
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Feb 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Revisit issue forms
1 participant