Docs improvements #30337

nnsW3 commented at 4:12 PM on June 25, 2024: none

Rectify typographical inaccuracies

This PR addresses several typographical errors across various files in the project. The changes improve readability and maintain the professional standard of the documentation and code comments.

Justification Typographical errors, while minor, can detract from the overall quality of the project. Correcting these errors ensures clarity and professionalism, making the project more accessible and understandable for current and future contributors.

fix README.md 927f2d82f3

fix 06_script.sh 18c6e4cd1a

fix 00_setup_env.sh b66b885186

fix README.md ca92e952f4

fix JSON-RPC-interface.md eb2e239377

fix README_doxygen.md e24c2a580d

fix bitcoin-conf.md f5a386ad87

fix build-osx.md c657d88f65

DrahtBot commented at 4:12 PM on June 25, 2024: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process. A summary of reviews will appear here.

jonatack commented at 4:26 PM on June 25, 2024: member

Hi @nnsW3, several of these proposed changes are incorrect. I suggest reading through https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md and https://jonatack.github.io/articles/how-to-contribute-pull-requests-to-bitcoin-core for an idea of contributions that would be useful to this project and valued. Cheers.

in ci/test/00_setup_env.sh:19 in c657d88f65 outdated

  16 |  # The destination root dir inside the container.
  17 |  # This folder will also hold any SDKs.
  18 |  # This folder only exists on the ci guest and will be a copy of BASE_READ_ONLY_DIR
  19 |  export BASE_ROOT_DIR="${BASE_ROOT_DIR:-/ci_container_base}"
  20 | -# The depends dir.
  21 | +# The depends on dir.

maflcko commented at 6:48 AM on June 26, 2024:

wrong: DEPENDS_DIR is the "depends dir".

maflcko changes_requested

Update 00_setup_env.sh 55009368f3

nnsW3 commented at 7:04 AM on June 26, 2024: none

solve the inconvenience

1alexbc1 approved

maflcko changes_requested

maflcko commented at 8:23 AM on June 26, 2024: member

Other changes are also still wrong, see #30337 (comment)

Please make sure all changes are correct, then please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

willcl-ark commented at 11:20 AM on June 26, 2024: member

Is this even worth keeping open? By my count only 2 of the 8 commits are arguably correct, and it hardly seems worth the review/merge effort at that point...

edit: removed unjustified comment about OP

maflcko commented at 11:29 AM on June 26, 2024: member

Ok, closing for now due to controversy. I think clear, correct and uncontroversial fixes are fine. However, if something is unclear, controversial and wrong, it seems better to avoid.

maflcko closed this on Jun 26, 2024

maflcko commented at 11:30 AM on June 26, 2024: member

If you are looking for other contributions, see:

Getting started to contribute to Bitcoin Core

Setting up your development environment

New developers are very welcome and needed. There are a lot of open issues of any difficulty waiting to be fixed. However, before you start contributing, familiarize yourself with the Bitcoin Core build system and tests. Refer to the documentation in the repository on how to build Bitcoin Core and how to run the unit and functional tests. Once that is done, you are all set.

If you need more help getting started, please refer to the following resources:

Pick something to work on

If you are looking for useful contributions to help out with, you can

Spend time on in-depth review of open pull requests and compare your review with the review done by others. This may be time-consuming, but it will teach you relevant skills for this project and for yourself to apply elsewhere. Moreover, on some pull requests there remain small follow-ups that were found during review, so you'll naturally find stuff to work on if you start out by reviewing pull requests done by others.
Search through the good first issues or the ones that are up for grabs. Some of them might no longer be applicable. So if you are interested, but unsure, you might want to leave a comment on the issue first.
Write tests to improve the coverage. Any kind of test is welcome and coverage information can be obtained from a relatively recent coverage report. If you are unsure, don't hesitate to check back first.
Help with review and testing. There are easy ones such as the gui and rpc. However, review on any open pull request is welcome. Review will also help you understand the codebase better.
Help on meta projects related to Bitcoin Core, such as https://github.com/corecheck.
Join the Bitcoin Core IRC channel(s) and leave a comment to share what you are interested in.

bitcoin locked this on Jun 26, 2025