Skip to content

Update PR and issue templates - #2993

Merged
sairina merged 6 commits into
learningequality:hotfixesfrom
sairina:pr-issues-templates
Feb 28, 2021
Merged

Update PR and issue templates#2993
sairina merged 6 commits into
learningequality:hotfixesfrom
sairina:pr-issues-templates

Conversation

@sairina

Copy link
Copy Markdown
Contributor

Description

  • More closely aligns the PR and issue templates for Studio to Kolibri's
  • Splits issue template and enhancement template
  • Updates the version of issue templates workflow (see warning below)

image

Issue Addressed (if applicable)

Addresses #2919

Comments

  • If this is accepted, we will want to let the content platform circle know about the change so they're not surprised before/after the fact.
  • There is still a list of reviewers, but I am sure there may be new folks we want to add to the list, if we are going to keep the list.

Comment thread.github/pull_request_template.md Outdated

@indirectlylitindirectlylit 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.

I appreciate the work here! This is a hard problem and there are lots of considerations and factors so I am a big fan of making iterative changes and not blocking forward progress.

One high level consideration is that we've seen big differences between how contributors inside and outside LE learn to use our templates. Specifically, outside contributors have always struggled with complex Markdown/HTML syntax, and more generally don't follow instructions as well, and we also want to be encouraging and supportive of their attempts to help improve the products.

Comment thread.github/ISSUE_TEMPLATE/enhancement_template.md
Comment thread.github/ISSUE_TEMPLATE/issue_template.md Outdated
Comment thread.github/ISSUE_TEMPLATE/issue_template.md Outdated
Comment thread.github/pull_request_template.md
Comment thread.github/ISSUE_TEMPLATE/enhancement_template.md
@sairina
sairina changed the base branch from hotfixes to developFebruary 25, 2021 22:11
@sairina
sairina changed the base branch from develop to hotfixesFebruary 25, 2021 22:11

@indirectlylitindirectlylit 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.

thanks! couple suggestions inline.

Github issue and PR templates might be a good thing to discuss at the Dev Meeting to understand peoples' experience with the ergonomics of using them.

For example, vue.js does not use templates, but instead links to an external form for issue creation:

This sort of flow is especially helpful for external contributors who might not...

  • know which git repo to post an issue in
  • know how to use markdown formatting
  • understand to provide all required details

2021-02-26 15 54 52

Comment thread.github/pull_request_template.md Outdated
Comment thread.github/ISSUE_TEMPLATE/issue_template.md Outdated
Comment thread.github/ISSUE_TEMPLATE/issue_template.md Outdated
Comment thread.github/ISSUE_TEMPLATE/issue_template.md Outdated
sairinaand others added 4 commits February 26, 2021 16:25
Co-authored-by: Devon Rueckner <indirectlylit@users.noreply.github.com>
Co-authored-by: Devon Rueckner <indirectlylit@users.noreply.github.com>
Co-authored-by: Devon Rueckner <indirectlylit@users.noreply.github.com>
Co-authored-by: Devon Rueckner <indirectlylit@users.noreply.github.com>
@sairina

Copy link
Copy Markdown
ContributorAuthor

Wow - that's fancy. Yes! I'll bring it up to the team, at the dev meeting.

@sairina
sairina merged commit 382b8e5 into learningequality:hotfixesFeb 28, 2021
Sign up for freeto 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

@sairina@rtibbles@indirectlylit