Fix MD linting in CONTRIBUTING.md #20086

pull Rav3nPL wants to merge 2 commits into bitcoin:master from Rav3nPL:patch-1 changing 1 files +80 −94
  1. Rav3nPL commented at 4:14 PM on October 5, 2020: contributor

    Format document to consistent markdown rules:

    • all lists use "-" (dash) - it was mixed with "*" (asterisk)
    • equally indent all lists
    • fix two "bare" links
    • all headers styles use "atx" - it was mixed with "setext", but we need 3 heading levels there
    • removed needless empty lines

    Added missing comma.

    <!-- *** Please remove the following help text before submitting: *** Pull requests without a rationale and clear improvement may be closed immediately. GUI-related pull requests should be opened against https://github.com/bitcoin-core/gui first. See CONTRIBUTING.md -->

    <!-- Please provide clear motivation for your patch and explain how it improves Bitcoin Core user experience or Bitcoin Core developer experience significantly: * Any test improvements or new tests that improve coverage are always welcome. * All other changes should have accompanying unit tests (see `src/test/`) or functional tests (see `test/`). Contributors should note which tests cover modified code. If no tests exist for a region of modified code, new tests should accompany the change. * Bug fixes are most welcome when they come with steps to reproduce or an explanation of the potential issue as well as reasoning for the way the bug was fixed. * Features are welcome, but might be rejected due to design or scope issues. If a feature is based on a lot of dependencies, contributors should first consider building the system outside of Bitcoin Core, if possible. * Refactoring changes are only accepted if they are required for a feature or bug fix or otherwise improve developer experience significantly. For example, most "code style" refactoring changes require a thorough explanation why they are useful, what downsides they have and why they *significantly* improve developer experience or avoid serious programming bugs. Note that code style is often a subjective matter. Unless they are explicitly mentioned to be preferred in the [developer notes](/doc/developer-notes.md), stylistic code changes are usually rejected. -->

    <!-- Bitcoin Core has a thorough review process and even the most trivial change needs to pass a lot of eyes and requires non-zero or even substantial time effort to review. There is a huge lack of active reviewers on the project, so patches often sit for a long time. -->

  2. Update CONTRIBUTING.md
    Format document to consistent markdown rules:

- all lists use "-" (dash) - it was mixed with "*" (asterisk)
- equally indent all lists
- fix two "bare" links
- all headers styles use "atx" - it was mixed with "setext", but we need 3 heading levels there
- removed  needless empty lines 

Added missing comma.
    70e5398053
  3. MarcoFalke commented at 4:33 PM on October 5, 2020: member

    This is a massive diff, the rendered markdown difference is empty and the travis linter doesn't pass. Slightly tend toward NACK, as it is not worth reviewing.

    If you want to contribute to Bitcoin Core, refer to the following section.

    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

    • 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 a high-level performance monitor.
    • Join us on irc and let us know what you are interested in.
  4. Rav3nPL commented at 4:42 PM on October 5, 2020: contributor

    Diff is big only because of formatting lists. Rendered markdown is not changed (except for comma) as intended. This is only formatting fix, not contents change. I have no idea why travis failing, log shows some odd stuff, not related to document itself.

  5. DrahtBot added the label Docs on Oct 5, 2020
  6. hebasto commented at 5:08 PM on October 5, 2020: member

    I have no idea why travis failing, log shows some odd stuff, not related to document itself.

    test/lint/lint-whitespace.sh -- trailing spaces?

  7. jonatack commented at 5:19 PM on October 5, 2020: member

    Tend to NACK, this is style change noise for no visible change per this markdown preview except for one single comma, and of all the places one could change a comma in the prose, it's not necessarily the only or optimal one.

  8. jonatack commented at 5:20 PM on October 5, 2020: member

    Help with review and testing... review on any open pull request is welcome. Review will also help you understand the codebase better.

    This is a great suggestion for how to contribute.

  9. Rav3nPL commented at 6:00 PM on October 5, 2020: contributor

    Just played witch liter in another project and saw same "errors" in files. Just wanted to make it cleaner and follow same linting rules in entire file. As in PR description. @hebasto no trailing spaces there.

  10. Rav3nPL renamed this:
    Update CONTRIBUTING.md
    Fix MD linting in CONTRIBUTING.md
    on Oct 5, 2020
  11. in CONTRIBUTING.md:85 in 70e5398053 outdated 
      88 |  
  89 | -For GUI-related issues or pull requests, the https://github.com/bitcoin-core/gui repository should be used.
  90 | -For all other issues and pull requests, the https://github.com/bitcoin/bitcoin node repository should be used.
  91 | +For GUI-related issues or pull requests, the
  92 | +[https://github.com/bitcoin-core/gui](https://github.com/bitcoin-core/gui) repository should be used.
  93 | +For all other issues and pull requests, the
    hebasto commented at 6:06 PM on October 5, 2020:

    @hebasto no trailing spaces there.

    $ test/lint/lint-whitespace.sh 
This diff appears to have added new lines with trailing whitespace.
The following changes were suspected:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -88,2 +83,4 @@ To contribute a patch, the workflow is as follows:
+For all other issues and pull requests, the
  12. Remove trailing space b8eea76cbb
  13. Rav3nPL commented at 6:12 PM on October 5, 2020: contributor

    @hebasto fixed. IDK how it get there, had no errors when copy/paste from editor.

  14. laanwj commented at 6:30 PM on October 5, 2020: member

    NACK, this is not worth doing IMO. We use the level 1 and level 2 headers as underlines everywhere, I don't see the reason to change this.

  15. laanwj closed this on Oct 5, 2020
  16. fanquake locked this on Oct 11, 2020
Contributors
Rav3nPLMarcoFalkehebastojonatacklaanwj
Labels
Docs
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-21 21:14 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me