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

docs(maintaining): add pull requests section #3378

Merged
merged 2 commits into from
May 13, 2021
Merged

docs(maintaining): add pull requests section #3378

merged 2 commits into from
May 13, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented May 12, 2021 •
edited

This PR adds a section about pull requests and associating with milestones to MAINTAINING.md.

Checklist

  • updated CHANGELOG.md

@jsjoeio jsjoeio added this to the v3.11.0 milestone May 12, 2021
@jsjoeio jsjoeio added the docs Documentation related label May 12, 2021
@jsjoeio jsjoeio self-assigned this May 12, 2021
@jsjoeio jsjoeio force-pushed the jsjoeio/milestones-issues branch from 8226bb4 to 5469e61 Compare May 12, 2021 22:36
@jsjoeio jsjoeio requested review from code-asher and oxy and removed request for code-asher May 12, 2021 22:36
@jsjoeio jsjoeio marked this pull request as ready for review May 12, 2021 22:37
@jsjoeio jsjoeio requested a review from a team as a code owner May 12, 2021 22:37
@codecov
Copy link

codecov bot commented May 12, 2021 •
edited

Codecov Report

Merging #3378 (c0b2748) into main (d2337bc) will not change coverage.
The diff coverage is n/a.

❗ Current head c0b2748 differs from pull request most recent head 7be1ae3. Consider uploading reports for the commit 7be1ae3 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3378   +/-   ##
=======================================
  Coverage   59.21%   59.21%           
=======================================
  Files          35       35           
  Lines        1709     1709           
  Branches      379      379           
=======================================
  Hits         1012     1012           
  Misses        559      559           
  Partials      138      138

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d2337bc...7be1ae3. Read the comment docs.

bpmct
bpmct approved these changes May 13, 2021
View reviewed changes
Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

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

fixed a minor typo with the semver URL in this too

docs/MAINTAINING.md Outdated
Comment on lines 76 to 77
### Merge Strategies

For most things, we recommend "Squash and Merge". If you're updating `lib/vscode`, we suggest using the "Rebase and Merge" strategy. There may be times where "Create a merge commit" makes sense as well. Use your best judgement.
Copy link
Member

Choose a reason for hiding this comment

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

Awesome to see this included.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for fixing that typo too!

Copy link
Contributor

Choose a reason for hiding this comment

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

Examples are always nice - for the "Create a merge commit" flow, if you have any. You might also want to mention that if you're unsure, to discuss with the team?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't have a good example off the top of my head but if you have one and want to add it, feel free to add in a follow-up PR? I'll add that last part about discussing with the team though! Good idea.

@jsjoeio jsjoeio force-pushed the jsjoeio/milestones-issues branch 2 times, most recently from b6e5455 to 9e8d233 Compare May 13, 2021 17:17
oxy
oxy approved these changes May 13, 2021
View reviewed changes
Copy link

@oxy oxy left a comment

Choose a reason for hiding this comment

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

Looks good!

@jsjoeio jsjoeio enabled auto-merge May 13, 2021 19:25
@jsjoeio jsjoeio force-pushed the jsjoeio/milestones-issues branch from 9e8d233 to 89afe9c Compare May 13, 2021 19:25
@jsjoeio jsjoeio disabled auto-merge May 13, 2021 19:25
@jsjoeio jsjoeio enabled auto-merge May 13, 2021 19:27
@jsjoeio jsjoeio force-pushed the jsjoeio/milestones-issues branch from 89afe9c to 7be1ae3 Compare May 13, 2021 19:27
@jsjoeio jsjoeio merged commit 10f512c into main May 13, 2021
@jsjoeio jsjoeio deleted the jsjoeio/milestones-issues branch May 13, 2021 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jawnsy jawnsy jawnsy left review comments

@oxy oxy oxy approved these changes

@bpmct bpmct bpmct approved these changes

@code-asher code-asher Awaiting requested review from code-asher

Assignees

@jsjoeio jsjoeio

Labels
docs Documentation related
Projects
None yet
Milestone
v3.10.1
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jsjoeio @jawnsy @oxy @bpmct