Merge rust-bitcoin/rust-bitcoin#2542: Improve contributing doc

41f0a802af Remove assigned docs (Tobin C. Harding)
7ba63fec82 Fix typo (Tobin C. Harding)

Pull request description:

  Do two trivial improvements to the contributing doc. Yes, I am struggling to find stuff to work on because hex is clogging the pipeline :)

ACKs for top commit:
  apoelstra:
    ACK 41f0a802af

Tree-SHA512: f6a302d4b26b36b4d73aea38ae43230811ad266296706b31bbf220f8031ea4e95feaa770bc28f030495cb41762c7cb2ad6583393323c444389a503f4a2b58689
This commit is contained in:
Andrew Poelstra 2024-03-06 17:46:36 +00:00
commit 0a62e3bc37
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 1 additions and 7 deletions

View File

@ -78,7 +78,7 @@ To contribute a patch, the workflow is a as follows:
2. Create topic branch 2. Create topic branch
3. Commit patches 3. Commit patches
Please keep commits should atomic and diffs easy to read. For this reason Please keep commits atomic and diffs easy to read. For this reason
do not mix any formatting fixes or code moves with actual code changes. do not mix any formatting fixes or code moves with actual code changes.
Further, each commit, individually, should compile and pass tests, in order to Further, each commit, individually, should compile and pass tests, in order to
ensure git bisect and other automated tools function properly. ensure git bisect and other automated tools function properly.
@ -91,12 +91,6 @@ to split it into multiple small, focused PRs.
Commits should cover both the issue fixed and the solution's rationale. Commits should cover both the issue fixed and the solution's rationale.
Please keep these [guidelines](https://chris.beams.io/posts/git-commit/) in mind. Please keep these [guidelines](https://chris.beams.io/posts/git-commit/) in mind.
To facilitate communication with other contributors, the project is making use
of GitHub's "assignee" field. First check that no one is assigned and then
comment suggesting that you're working on it. If someone is already assigned,
don't hesitate to ask if the assigned party or previous commenters are still
working on it if it has been awhile.
## Preparing PRs ## Preparing PRs