doc: Updated notes on how to contribute to Bitcoin Knots.#314
Conversation
Retropex
left a comment
Retropex
left a comment
There was a problem hiding this comment.
ACK afcc758fd375def1604e8afc4493fd09d14bf1fd
| @@ -84,8 +77,7 @@ To contribute a patch, the workflow is as follows: | |||
| 1. Create topic branch | |||
| 1. Commit patches | |||
|
|
|||
| For GUI-related issues or pull requests, the https://github.com/bitcoin-core/gui repository should be used. | |||
| For all other issues and pull requests, the https://github.com/bitcoin/bitcoin node repository should be used. | |||
| For all issues and pull requests, the https://github.com/bitcoinknots/bitcoin node repository should be used. | |||
There was a problem hiding this comment.
This line now says a single repository is used for all issues and pull requests, but the block immediately below (lines 82-97) still describes Bitcoin Core's two-repo split. It references "monotree repositories," routing src/qt GUI-only changes, and recommends to "first open a pull request against the GUI repository."
Bitcoin Knots has no separate GUI repository, so this section contradicts the update on this line and should be removed or rewritten. As-is, a contributor is told to use one repo here and then directed to a non-existent GUI repo just below.
There was a problem hiding this comment.
Having never used the GUI until recent testing, I was not knowledgeable enough to assess this section.
I have incorporated this information and will push an update shortly.
|
For full consistency with the comms-channel update in this PR (IRC + mailing list -> Discord), several later references still point contributors to IRC and the mailing list, which Knots no longer uses:
Suggest updating these to Discord (and dropping "mailing list") so the whole document points to the same channel. |
|
Thank you for your feedback. I have replaced the IRC references with Discord. |
|
|
||
| Note that translations should not be submitted as pull requests. Please see | ||
| [Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md) | ||
| [Translation Process](doc/translation_process.md) |
There was a problem hiding this comment.
This doc itself needs revision since Core stole the repo
There was a problem hiding this comment.
I'd prefer to put that into a separate pull request. Otherwise, we may end up deferring this update while all documentation gets refreshed.
This is a primary document that new contributors will read, and getting into the LTS support train will help bring more developers on board faster.
| @@ -232,7 +207,7 @@ pull request to pull request. | |||
|
|
|||
| When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch. | |||
There was a problem hiding this comment.
We don't actually want rebasing here
There was a problem hiding this comment.
Shall I remove this sentence? Otherwise, what would be the correct approach?
I am very new to this project, so I am not familiar with these finer points.
4 participants
The current documentation on how to contribute to Bitcoin Knots contains outdated and incorrect information. This makes it difficult for new contributors to assist, as it leads them in directions away from what is required.
I have updated the documentation regarding current communication methods, fixed many links that pointed to Bitcoin Core instead of Bitcoin Knots, and removed irrelevant documentation.