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.

Sign up for GitHub

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

Jump to bottom

Improve PR/issues templates #453

Merged
merged 3 commits into from Dec 21, 2021
Merged

Improve PR/issues templates #453

merged 3 commits into from Dec 21, 2021

Conversation

erikmd
Copy link
Member

@erikmd erikmd commented Nov 2, 2021 •
edited

Description

  • Add a PULL_REQUEST_TEMPLATE.md file with a standard checklist
  • Improve the ISSUE_TEMPLATE/* files a bit

Checklist

Note to maintainers

  • Read this wiki page
  • Make sure the PR has a milestone
  • Assign yourself before merging

@erikmd erikmd added needs: merge of dependency This PR depends on another PR being merged first. kind: documentation labels Nov 2, 2021
@erikmd erikmd added this to the learn-ocaml 0.14.0 milestone Nov 2, 2021
@erikmd erikmd requested a review from yurug November 2, 2021 19:54
@erikmd erikmd force-pushed the improve-templates branch 2 times, most recently from 7b911a8 to 5b61366 Compare November 2, 2021 20:34
@erikmd erikmd removed the needs: merge of dependency This PR depends on another PR being merged first. label Nov 2, 2021
@erikmd erikmd mentioned this pull request Nov 16, 2021
Closed
15 tasks
@erikmd
docs: Refactor .github/ISSUE_TEMPLATE/*
1396853 
* Use <!--HTML comments--> more often & Tweak details
@erikmd
Copy link
Member Author

erikmd commented Dec 6, 2021 •
edited

Hi @yurug! do you think you'll have the time to take a look at this PR by our next meeting?

(this PR is now fairly independent of my other documentation PR #452,
and it'll be quite useful to provide users with improved issue templates and, what is new in this PR, a Pull-Request template).

Here are some direct links to the Markdown files to ease review:

Rendered version Raw version with <!--comments to reporter-->
bug_report.md raw version of bug_report.md
feature_request.md raw version of feature_request.md
question.md raw version of question.md
PULL_REQUEST_TEMPLATE.md raw version of PULL_REQUEST_TEMPLATE.md

erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Dec 6, 2021
@erikmd
chore: Temporarily fix CONTRIBUTING.md broken link
efbcff6 
This patch,
just required if PR <ocaml-sf#453>
is merged before PR <ocaml-sf#452>,
can be reverted anytime soon.
@erikmd
Copy link
Member Author

erikmd commented Dec 14, 2021

Dear @yurug,
just a small ping ­(maybe some users will open issues after reading my caml-list message, so merging this PR would by timely :)

@erikmd
docs: Add PULL_REQUEST_TEMPLATE.md
cb64bd7
@erikmd
chore: Temporarily fix CONTRIBUTING.md broken link
d3c7e9b 
This patch,
just required if PR <ocaml-sf#453>
is merged before PR <ocaml-sf#452>,
can be reverted anytime soon.
@erikmd
Copy link
Member Author

erikmd commented Dec 14, 2021 •
edited

@yurug indeed I believe it was very important to make the Conventional-Commits constraint explicit…
(given even if it's documented in CONTRIBUTING.md, I guess advanced developers may not systematically read it :)

So feel free to merge the PR if you're OK with the current version! 🙂

@yurug yurug merged commit d511d58 into ocaml-sf:master Dec 21, 2021
@yurug
Copy link
Collaborator

yurug commented Dec 21, 2021

Thank you!

@erikmd erikmd deleted the improve-templates branch December 21, 2021 16:01
@erikmd
Copy link
Member Author

erikmd commented Dec 21, 2021 •
edited

Hi @yurug, thanks!

BTW I've just noticed that the last commit in master wasn't taken into account by release-please:

https://github.com/ocaml-sf/learn-ocaml/pull/460/files

But it seems "logical"… as the automatic message that GItHub chose for the Squash-Merged commit d511d58 does not strictly follows the conventional commit format (which would require that the very first line of the message is of the form docs: …).

So maybe let's say that for upcoming PRs, we should always use a regular Merge - unless there is only one commit in the PR…

erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Jan 7, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly
d2a0b95 
This patch is a follow-up of PR ocaml-sf#453
@erikmd erikmd mentioned this pull request Jan 7, 2022
Merged
3 tasks
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Jan 7, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly
ff46bdd 
This patch is a follow-up of PR ocaml-sf#453
@erikmd erikmd mentioned this pull request Jan 7, 2022
Closed
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Jan 7, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly
6d99f9a 
This patch is a follow-up of PR ocaml-sf#453
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Jan 7, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly
fb66aa7 
This patch is a follow-up of PR ocaml-sf#453
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Jan 7, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly
b56268d 
This patch is a follow-up of PR ocaml-sf#453
yurug pushed a commit that referenced this pull request Jan 21, 2022
@erikmd
docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly (#464)
e3ff435 
This patch is a follow-up of PR #453
@erikmd erikmd mentioned this pull request Feb 26, 2022
Merged
@proofbot proofbot mentioned this pull request Mar 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yurug yurug yurug left review comments

Assignees

@yurug yurug

Labels
kind: documentation
Projects
None yet
Milestone
learn-ocaml 0.14.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@erikmd @yurug