aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2024-05-22doc: Correct pull request prefix for scripts and toolsMarcoFalke
2024-04-30Merge bitcoin/bitcoin#29645: doc: update release-process.mdAva Chow
1ea8674316f2dce0005f6094b6ee111b045dd770 [doc] update release-process.md and backports section of CONTRIBUTING (glozow) Pull request description: While doing various release process things for the first time, I noticed some of our docs are outdated and/or confusing. ACKs for top commit: achow101: ACK 1ea8674316f2dce0005f6094b6ee111b045dd770 Tree-SHA512: 4ad10d4ce2c33fe15cb02599353107bb72ecb867aefc6c120cfd5cdea42aa8fa3783f9e0218c2f3815f030e0694cc8fb24011ce88358a0206cb07416a256a962
2024-04-18[doc] update release-process.md and backports section of CONTRIBUTINGglozow
- Mention which directories contain the respective unsigned tarballs - Clarify that bitcoin.conf might not need to be updated - Specify where to put historical release notes if there is already something in release-notes.md - Clarify what exactly is the problem with running guix-codesign more than once - Correct number: 6 codesigned attestations are needed before uploading binaries - Remove scp command which is outdated - Remove server path which is outdated - Specify that translations update should happen before branch-off, not before each release candidate - Mention that you should notify lists when RCs are available - Put "Archive the release notes" as a separate step, since creating the github release has a dependency on it. - Put bitcoincore.org website updates as a separate step, since updating packaging repos may have a dependency on it. - Update "bitcoin-dev mailing list" to "bitcoin-dev group" - Document that maintainers should create PRs to collect backports - Remove section about not uploading `*-debug` files, reader should upload all build artifacts. - Torrent is created automatically, so delete instructions. - Mention that server also generates ots file automatically.
2024-04-02Update the developer mailing list address.Edil Medeiros
The developer mailing list was migrated to Google Groups in February 2024 as announced in https://groups.google.com/g/bitcoindev/c/aewBuV6k-LI. The archives maintained by the Linux Foundation stopped updating in December 2024. Thus, we point to the new archive maintained by gnusha.org. The codebase refers to old discussions linked to the Linux Foundation archives. Since all links are still active to this date, we keep them as they are. See #29782.
2022-05-24doc: Explain squashing with merge commitsMacroFake
2022-05-06doc: Shorten explanation of "maintainers"MacroFake
2022-03-09doc: Add `guix` prefix for changes to reproducible buildsHennadii Stepanov
2022-02-24doc: Explain that feedback needs to be addressedMarcoFalke
2022-02-23doc: Move peer-review paragraph to right sectionMarcoFalke
2022-02-23doc: Add link to release-process.md in CONTRIBUTING.mdMarcoFalke
2021-12-10Use the imperative mood in example subject lineTobin Harding
The section `Committing Patches` contains an example commit subject line that violates rule seven of the linked guide to writing commit logs (Chris Beams famous blog post). We should practice what we preach, especially in examples :) Use the imperative mood in example commit message subject line.
2021-09-16Enable TLS in links in documentationJeremy Rand
2021-08-19doc: Update GitHub documentation linksSuriyaa Rocky Sundararuban
2021-05-31doc: Fix external links (IRC, ...)MarcoFalke
2021-02-22doc: Clarify that squashing should happen before reviewMarcoFalke
2020-08-07Replace `hidden service` with `onion service`Riccardo Masutti
For a couple of years, Tor documentation has made the term hidden service obsolete, in favor of onion service. This PR updates all the references in the code base.
2020-07-12doc: CONTRIBUTING.md improvementsJon Atack
2020-06-08doc: Mention repo split in the READMEsMarcoFalke
2020-05-28doc: Explain that anyone can work on good first issues, move text to ↵MarcoFalke
CONTRIBUTING.md
2020-05-28doc: Expand section on Getting StartedMarcoFalke
Co-authored-by: Adam Jonas <jonas@chaincode.com> Co-authored-by: Jon Atack <jon@atack.com>
2020-05-28doc: Add headings to CONTRIBUTING.mdMarcoFalke
This makes it possible to link and refer to subsections Also, minor clarifications
2020-03-11Merge #18283: doc: Explain rebase policy in CONTRIBUTING.mdWladimir J. van der Laan
fa1244783ccb4798af4906ac6be5a38df241fa38 doc: Explain rebase/squash policy in CONTRIBUTING.md (MarcoFalke) Pull request description: ACKs for top commit: hebasto: re-ACK fa1244783ccb4798af4906ac6be5a38df241fa38, typos fixed. laanwj: ACK fa1244783ccb4798af4906ac6be5a38df241fa38 Tree-SHA512: b8f790a8ffa4f59f26b64befbea8acd92f3c548e577c35750a60dde94b4340258a540ad0db60a6de650db0156cbff9e1330c589c300db5253531fe6a16cdbcc9
2020-03-11Merge #18170: doc: Minor grammatical changes and flow improvementsMarcoFalke
7ba962276e3e540a15eb0bdbbaaa101958229bd4 doc: Minor grammatical changes and flow improvements (Travin Keith) Pull request description: **Grammar:** Line 49: There shouldn't be a period at the end of a phrase. Lines 56, 57, 116, 137, and 177: Adding necessary commas Lines 103 and 136: Run-on sentence issues fixed. Line 176: Fixed punctuation and added necessary conjunction Line 178: Singular noun when it should be plural **Flow:** Line 49: Adding "for" makes it more natural. Line 54: Though it's not grammatically incorrect to end a sentence with a preposition in an informal document such as this, the word "followed" is much easier to understand anyway, especially for those who don't have English as their native language. Top commit has no ACKs. Tree-SHA512: 17fdb5fc6146e025f160e860dbcbdbfa07b7608b8cb611c3b9d4ed91c426100ef772915251bc1f6bacb3a62df57b72c2003fb72cb2c8542454638545985313da
2020-03-11doc: Explain rebase/squash policy in CONTRIBUTING.mdMarcoFalke
2020-02-18doc: Minor grammatical changes and flow improvementsTravin Keith
Grammar: Line 49: There shouldn't be a period at the end of a phrase. Lines 56, 57, 116, 137, and 177: Adding necessary commas Lines 103 and 136: Run-on sentence issues fixed. Line 176: Fixed punctuation and added necessary conjunction Line 178: Singular noun when it should be plural Flow: Line 49: Adding "for" makes it more natural. Line 54: Though it's not grammatically incorrect to end a sentence with a preposition in an informal document such as this, the word "followed" is much easier to understand anyway, especially for those who don't have English as their native language.
2020-01-06doc: Add a note about backportingCarnhof Daki
See laanwj's comment in #17158 https://github.com/bitcoin/bitcoin/pull/17158#issuecomment-542627090 Co-Authored-By: Wladimir J. van der Laan <laanwj@protonmail.com> Co-Authored-By: Hennadii Stepanov <32963518+hebasto@users.noreply.github.com> Co-Authored-By: João Barbosa <joao.paulo.barbosa@gmail.com> Co-Authored-By: Michael <fanquake@gmail.com> Co-Authored-By: Luke Dashjr <luke-jr+git@utopios.org>
2020-01-04Merge #17688: doc: Add "ci" prefix to CONTRIBUTING.mdfanquake
19267cbc82c1a09b37a0266b7bd930e9a62d1288 doc: Add ci prefix to CONTRIBUTING.md (Hennadii Stepanov) Pull request description: It seems our maintainers like `ci` prefix for commits and PRs: ``` git log | grep 'ci:' ``` and ![Screenshot from 2019-12-07 11-49-51](https://user-images.githubusercontent.com/32963518/70372457-ec592a80-18e7-11ea-9320-73412a1ccd25.png) So let's document it. ACKs for top commit: fanquake: ACK 19267cbc82c1a09b37a0266b7bd930e9a62d1288 - this looks ok Tree-SHA512: ef467513f9562f51d0471c5cc900336caab4e9494299bcd2c9cc9e1b296536a86467807d71b8d7100a5c78715174cf58b6ecfe6c3bd958060c15eba4fba7067f
2019-12-18doc: Mention PR Club in CONTRIBUTING.mdEmil Engler
2019-12-15doc: Add ci prefix to CONTRIBUTING.mdHennadii Stepanov
2019-10-20doc: Added instructions for how to add an upsteam to forked repodannmat
As a first time git developer, I struggled to understand whether to create a new fork for each pull request or not. After asking the IRC chat, I have added this to the documentation to further help new developers using git. Co-Authored-By: Michael <fanquake@gmail.com>
2019-08-26doc: Update labels in CONTRIBUTING.mdHennadii Stepanov
Add `build' label. Make labels lowercase. Split long labels.
2019-07-29doc: update labels in CONTRIBUTING.mdMarcoFalke
2019-06-13doc: Rework section on ACKMarcoFalke
2019-04-11docs: Clarify PR guidelines w/re documentationCarl Dong
2019-03-20Doc: update ACK description in CONTRIBUTING.mdJon Atack
as per https://github.com/bitcoin/bitcoin/pull/15617#issuecomment-474773043 and https://github.com/bitcoin/bitcoin/pull/15626#discussion_r267286564.
2019-03-11Enable TLS in link to chris.beams.ioJeremyRand
2019-01-01Botbot.me (IRC logs) not available anymoreAntti Majakivi
Remove botbot.me link and add two other IRC history log sources: logs for #bitcoin-core-dev at http://www.erisian.com.au/bitcoin-core-dev/ and http://gnusha.org/bitcoin-core-dev/
2018-10-30added details about commit messagesMartin Erlandsson
2018-07-30doc: add note to contributor docs about warranted PR'sKarl-Johan Alm
2018-06-17Docs: Improve readability of "Squashing commits"wodry
It was not easy to read the comment lines for me because I was not sure whether the sentence ended with the line or not ("pull set commits"?). Therefore, dots had been invented and I have added them to signal the end of a sentence. Also begin New sentence with a capital letter. I guess, not all 'pick' words should be replaced by 'squash'? At least I found [https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request](this) rebase/squash documentation helpful, where is written that the first line should not be changed.
2018-05-04doc: Mention good first issue list in CONTRIBUTING.mdfanquake
2018-03-22Docs: Improve documentation on standard communication channelsJim Posen
More information about connection on IRC will hopefully help new contributors.
2017-11-20[docs] links to code style guidesSjors Provoost
2017-11-07Docs: Change formatting for sequence of stepsVivek Ganesan
A numbered list is used when the sequence of steps matters. A bulleted list is used to denote a set of items where the sequence does not matter. The workflow is a sequence and hence changed to a numbered list.
2017-10-28Fixed a couple small grammatical errors.Christian Gentry
1. "If a pull request is not to be considered for merging (yet), please prefix the ..." 2. If a particular commit references another issue, please add the reference. For example: `refs #1234` or `fixes #4321`.
2017-09-07Update CONTRIBUTRING.md to reduce unnecesarry review workloadJonas Schnelli
2017-09-05Add translation note to CONTRIBUTING.mdMeshCollider
2017-08-08Capitalize bullet points in CONTRIBUTING guideEvan Klitzke
English grammar dictates that these bullet points should be capitalized. This also makes the capitalization style consistent with the rest of the document, e.g. the "Decision Making Process" section.
2017-04-17[doc] Add blob about finding reviewers.Kalle Alm
2017-04-14[doc] Wording fixes in CONTRIBUTING.md.Kalle Alm
generated by cgit v1.2.3 (git 2.26.2) at 2024-11-22 14:37:11 +0000