Skip to content

feat: enhance moderation experience - #449

Merged
jrvidal merged 2 commits into
stackblitz:mainfrom
geromegrignon:feat/moderation
Dec 3, 2021
Merged

feat: enhance moderation experience#449
jrvidal merged 2 commits into
stackblitz:mainfrom
geromegrignon:feat/moderation

Conversation

@geromegrignon

Copy link
Copy Markdown
Contributor

Description

related discussion on #446

Changes

Isue Template

new-framework-support has been changed from a GitHub Template to a GitHub Form, enforcing the content completion.

The Describe the solution you'd like section is a textarea field supporting markdown format. There is a required validation upon it to be able to submit the issue to create it.

The Provide a link to a GitHub repo containing an example of the framework is a simple input field as it only includes an URL. No required validation.

The Additional context is a textarea field supporting markdown format. No required validation.

An example of the experience provided is available here

PS: If the required validation doesn't prove itself to be enough to mitigate low quality contributions, I might create a GitHub Action to close related issues opened with the [FRAMEWORK NAME] part of the title still present.

GitHub Action

A GitHub Action has been added to close issues opened with an empty body.
Even if most of these issues are putting little effort and are opened mainly by GitHub new users, I would encourage adding a closing message as a promotion for more meaningful contributions. By automating it with the GitHub Action, it wouldn't require any further work for the maintainers.

An example of the experience provided is available here

@geromegrignon

Copy link
Copy Markdown
Contributor Author

Besides the global context, here are some details to review:

  • the field type for each section of the GitHub Issue Form (using a simple input field or a textarea)
  • the required validation on different fields
  • a closing message to be added for the GitHub Action

@jrvidal

@jrvidal jrvidal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This LGTM @geromegrignon , a few minor comments

Comment thread .github/ISSUE_TEMPLATE/new-framework-support.yml
Comment thread .github/workflows/close-empty-issues.yml Outdated
change new-framework template to a form
add GitHub Action to close empty issues

related to #446
@geromegrignon

Copy link
Copy Markdown
Contributor Author

changes done.

Once merged, I'll create a related PR in the core repository.

@jrvidal jrvidal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👏

@jrvidal
jrvidal merged commit fca41a6 into stackblitz:main Dec 3, 2021
@geromegrignon
geromegrignon deleted the feat/moderation branch December 3, 2021 09:09
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.

2 participants