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

docs(contributing): add commits section #3377

Merged
merged 2 commits into from
May 14, 2021
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented May 12, 2021

This PR adds some note to CONTRIBUTING.md around clean commits.

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/docs-clean-commits branch from 071adbb to cf5efbb Compare May 12, 2021 22:25
@jsjoeio jsjoeio marked this pull request as ready for review May 12, 2021 22:25
@jsjoeio jsjoeio requested a review from a team as a code owner May 12, 2021 22:25
docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented May 12, 2021

Codecov Report

Merging #3377 (60d71fe) into main (a7cf990) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3377   +/-   ##
=======================================
  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 a7cf990...60d71fe. Read the comment docs.


### Commits

We prefer a clean commit history. This means you should squash all commits before asking for review (cleanup, squash, force-push). If you need help with this, feel free to leave a comment in your PR and we'll guide you.
Copy link
Member

Choose a reason for hiding this comment

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

squash all commits == PRs should only have one commit? Or does that just mean to squash fixups and fixup-type commits?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Squash fixups and fixup-type commits - let me reword to clarify! Good point.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed!

@jsjoeio jsjoeio force-pushed the jsjoeio/docs-clean-commits branch from ece723c to 0209e9f Compare May 14, 2021 20:24
@jsjoeio jsjoeio force-pushed the jsjoeio/docs-clean-commits branch from 0209e9f to 60d71fe Compare May 14, 2021 20:50
@jsjoeio jsjoeio enabled auto-merge May 14, 2021 20:50
@jsjoeio jsjoeio merged commit 509d91d into main May 14, 2021
@jsjoeio jsjoeio deleted the jsjoeio/docs-clean-commits branch May 14, 2021 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants