Skip to content

[CONTRIBUTING] add trivial change clause#7972

Merged
macfarla merged 3 commits intobesu-eth:mainfrom
macfarla:contributing-trivial
Dec 6, 2024
Merged

[CONTRIBUTING] add trivial change clause#7972
macfarla merged 3 commits intobesu-eth:mainfrom
macfarla:contributing-trivial

Conversation

@macfarla
Copy link
Copy Markdown
Contributor

@macfarla macfarla commented Dec 3, 2024

PR description

Adds a clause covering trivial changes. We've seen an increase in this type of PR lately (typos, punctuation, and other trivial changes). These add load to CI and also to reviewers. Until now we did not have a policy on these types of PRs.

These words came from Teku

Please keep in mind that we do not accept non-code contributions like fixing comments, typos or some other trivial fixes. Although we appreciate the extra help, managing lots of these small contributions is unfeasible, and puts extra pressure in our continuous delivery systems (running all tests, etc). Feel free to open an issue pointing any of those errors, and we will batch them into a single change.

Fixed Issue(s)

Thanks for sending a pull request! Have you done the following?

  • Checked out our contribution guidelines?
  • Considered documentation and added the doc-change-required label to this PR if updates are required.
  • Considered the changelog and included an update if required.
  • For database changes (e.g. KeyValueSegmentIdentifier) considered compatibility and performed forwards and backwards compatibility tests

Locally, you can run these tests to catch failures early:

  • unit tests: ./gradlew build
  • acceptance tests: ./gradlew acceptanceTest
  • integration tests: ./gradlew integrationTest
  • reference tests: ./gradlew ethereum:referenceTests:referenceTests

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Comment thread CONTRIBUTING.md
* To ask questions or chat with us, join our [Discord](https://discord.com/invite/hyperledger)
* To edit pages in our wiki, you'll need a [Linux Foundation (LF) account].

Please keep in mind that we do not accept non-code contributions like fixing comments, typos or some other trivial fixes. Although we appreciate the extra help, managing lots of these small contributions is unfeasible, and puts extra pressure in our continuous delivery systems (running all tests, etc). Feel free to open an issue pointing any of those errors, and we will batch them into a single change.
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.

If you add a header section, you should be able to link directly to it.

Copy link
Copy Markdown
Contributor

@siladu siladu left a comment

Choose a reason for hiding this comment

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

LGTM, linkable header section would be a minor improvement

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Copy link
Copy Markdown
Contributor

@lu-pinto lu-pinto left a comment

Choose a reason for hiding this comment

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

Even though there's some helpful comment fixes it can be a bit of a gray area what to and what not to allow, so I think not allowing them altogether is what makes most sense from the POV of time/resources wasted with little benefit.
The approach to just create issues for typos is a good one IMO.

Copy link
Copy Markdown
Contributor

@garyschulte garyschulte left a comment

Choose a reason for hiding this comment

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

🚢

@macfarla macfarla enabled auto-merge (squash) December 5, 2024 23:54
@macfarla macfarla merged commit 1637cef into besu-eth:main Dec 6, 2024
@macfarla macfarla deleted the contributing-trivial branch December 11, 2024 05:32
daniellehrner pushed a commit to daniellehrner/besu that referenced this pull request Dec 18, 2024
Signed-off-by: Daniel Lehrner <daniel.lehrner@consensys.net>
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.

9 participants