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

Convert issue templates in markdown to GitHub's issue forms #1562

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

Conversation

mitchelbaker-cisa
Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa commented Feb 11, 2025

🗣 Description

Converts markdown versions of "new idea" and "bug report" templates to Github's issue forms.

GitHub documentation if interested.

💭 Motivation and context

This issue would be useful because issue forms encourage specific, structured information we want included in issues, as well as required fields/input validation.

Closes #1283

🧪 Testing

Check out 1-newidea-scubagear.yaml and 2-bugreport-scubagear.yaml files for formatting/consistency (copied the same files into a personal repository to test since these files have to be committed to a main branch).

Please comment in this PR for any new inputs we want added to either the new issue or bug report templates.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
    - [ ] Unit tests added/updated to cover PowerShell and Rego changes.
    - [ ] Functional tests added/updated to cover PowerShell and Rego changes.
    - [ ] All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@mitchelbaker-cisa mitchelbaker-cisa added the enhancement This issue or pull request will add new or improve existing functionality label Feb 11, 2025
@mitchelbaker-cisa mitchelbaker-cisa added this to the Marlin milestone Feb 11, 2025
@mitchelbaker-cisa mitchelbaker-cisa self-assigned this Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert issue templates in markdown to Github's issue forms
1 participant