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

Typo fix Update CONTRIBUTING.md #22

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

0xbryer
Copy link
Contributor

@0xbryer 0xbryer commented Nov 25, 2024

Description:

This pull request addresses an ambiguity in the "Commits rules" section of the contributing guide, specifically in the description of commit message structure.

Problem:

The original text states:

Each commit message consists of a **header**, a **body** and a **footer**.

This statement implies that the body is a mandatory part of a commit message, which is not accurate. In reality, the body is optional, and not all commits will require a body.

Solution:

The wording has been updated to:

Each commit message consists of a **header**, an optional **body**, and a **footer**.

This clarification ensures that contributors understand the body is not required for every commit and prevents confusion.

Importance:

Clarifying that the body is optional helps contributors avoid unnecessary commits with empty bodies. This improves the clarity and consistency of the commit history, which is especially important for automated changelog generation and code review processes.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have run yarn test without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Clarify Commit Message Structure in "Commits rules" Section
@cedoor cedoor merged commit 19da08d into privacy-scaling-explorations:main Nov 26, 2024
2 checks passed
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