1. 16 Mar, 2021 1 commit
    • Dagur's avatar
      doc: Expectations of contributors and maintainers · 947b03dc
      Dagur authored
      Attempt to make it more clear what expectations exists of both
      contributors and maintainers, not to create new guidelines.
      
      Includes a new section about critical code paths.
      947b03dc
  2. 28 Jan, 2021 1 commit
    • Søren Bredlund Caspersen's avatar
      [doc] Reduce markdown lint errors · 80d66951
      Søren Bredlund Caspersen authored
      Reduce number of markdown lint errors by moving indented codeblocks to fenced codeblocks instead.
      Notice in CONTRIBUTING.md and doc/developer-notes.md that the code in lists now render as intended in the mkdocs output.
      
      Test-plan:
      
      - Check out master
      - `markdownlint -c .markdownlint.json -o /tmp/before CONTRIBUTING.md contrib/devtools/README.md contrib/seeds/README.md contrib/testgen/README.md doc/build-osx.md doc/build-unix.md doc/developer-notes.md doc/ninja_targets.md doc/unit-tests.md doc/gitian-building/gitian-building-create-vm-debian.md doc/gitian-building/gitian-building-manual.md`
      - Check out this MR
      - `markdownlint -c .markdownlint.json -o /tmp/after CONTRIBUTING.md contrib/devtools/README.md contrib/seeds/README.md contrib/testgen/README.md doc/build-osx.md doc/build-unix.md doc/developer-notes.md doc/ninja_targets.md doc/unit-tests.md doc/gitian-building/gitian-building-create-vm-debian.md doc/gitian-building/gitian-building-manual.md`
      - Compare the `before` a...
      80d66951
  3. 14 Jan, 2021 1 commit
  4. 08 Jan, 2021 1 commit
    • freetrader's avatar
      [doc] Add a useful link about writing good git commit messages · 41d28147
      freetrader authored
      Added a link to Chris Beam's article on good commit messages.
      The tips given there should be general enough to satisfy our
      requirements.
      
      We do not strictly enforce things like commit message length,
      formatting, content/metadata, most of our contributors generally
      and naturally adhere to the advice given in this article.
      And one can study the past project history to get a sense of
      style.
      
      Contributors should review the BCHN GitLab rules & guidelines,
      they contain more specific info on commit tags used etc.
      
      Test plan:
      - review / read the doc / approve the info
      41d28147
  5. 19 Dec, 2020 1 commit
    • Søren Bredlund Caspersen's avatar
      [DOC] Remove more line length warnings (MD013) · 66b958d8
      Søren Bredlund Caspersen authored
      Remove line-length warnings (MD013) from `/*.md`
      (and one new line in `/doc/functional-tests.md`)
      
      Test plan: (needs markdownlint v0.25.0 or later)
      - `markdownlint -c .markdownlint.json -o /tmp/mdl.output *.md doc/*.md`
      - `grep MD013 /tmp/mdl.output | egrep -v '(bips.md|bch-upgrades.md)'`
      
      Output file (`/tmp/mdl.output`) should contain MD013 entries only for
      `doc/bips.md` and `doc/bch-upgrades.md)`.
      The above `grep` command should not output any lines.
      66b958d8
  6. 30 Nov, 2020 1 commit
    • Søren Bredlund Caspersen's avatar
      [doc] Fix the ordered list in CONTRIBUTING.md · 11a38ce2
      Søren Bredlund Caspersen authored
      Numbering was broken, starting over again and again, instead of going from 1 to 9.
      This should make the ordered list in `CONTRIBUTING.md` render correctly with `mkdocs`.
      
      Test plan
      ---------
      
      Make sure you have `mkdocs` and `mkdocs-material` installed (`pip install mkdocs` and `pip install mkdocs-material` - adjust per your installation / distribution)
      
      Go to your working area root folder, and run the doc deployment prep commands from `.gitlab-ci.yml`:
      
      ```
      mkdir files-for-mkdocs
      (cd files-for-mkdocs ; ln -s ../* . ; rm -rf files-for-mkdocs)
      rm -f files-for-mkdocs/{depends,src}
      tar cf - $(find src depends -name \*.md) | ( cd files-for-mkdocs ; tar xf - )
      tar cf - src/chainparams.cpp src/crypto/sha256_sse4.cpp src/interfaces/*.h src/qt/intro.cpp src/univalue/COPYING | ( cd files-for-mkdocs ; tar xf - )
      rm -f files-for-mkdocs/doc/release-notes.md
      mkdocs build
      ```
      
      Then run `mkdocs serve` and browse to http://127.0.0.1:8000
      to take a look at the rendered document (and compare to previous
      version using the same doc building procedure on `master` before this change)
      11a38ce2
  7. 24 Aug, 2020 1 commit
  8. 13 Jul, 2020 1 commit
  9. 09 Jun, 2020 1 commit
    • Dagur's avatar
      [doc] Misc documentation fixes · c1d4225e
      Dagur authored
      - Change git alias `mr` so it doesn't conflict with existing use (see commit for details).
      - Update repo location for qa-assets.
      - Note about missing `test-runner.py` when fuzzing.
      
      Test plan: review
      c1d4225e
  10. 31 Mar, 2020 1 commit
  11. 13 Mar, 2020 1 commit
  12. 04 Feb, 2020 1 commit
    • Fabien's avatar
      [CMAKE] Enable clang-tidy · da6827e9
      Fabien authored
      Summary:
      This diff enables running `clang-tidy` at build time.
      
      The checks are defined in the `src/.clang-tidy` file, and apply to every
      subdirectories as well. For now, a single check is enabled to replace
      `boost::lexical_cast<std::string>` with `std::to_string` (see
      https://releases.llvm.org/8.0.0/tools/clang/tools/extra/docs/clang-tidy/checks/boost-use-to-string.html).
      This check should never trigger since D5136 removes
      `boost::lexical_cast`, and our libraries are not using boost.
      
      Depends on D5136.
      
      Test Plan:
      Pre-requisite: with no clang-tidy installed:
        cmake -GNinja ..
      Check that cmake returns an error because it fails to find `clang-tidy`.
        cmake -GNinja .. -DENABLE_CLANG_TIDY=OFF
        ninja
      Should return no error.
      
      Install `clang-tidy` version >= 8.
        cmake -GNinja ..
        ninja check-all bitcoin-bench
      
      Add a `boost::lexical_cast<std::string>` case in any bitcoin-abc source
      file, then run `ninja` again. Check that clang-tidy applied the fix and
      replaced it with `std::to_string`.
      Note: it seems that clang-tidy does not always replace, but sometimes
      only outputs the warning.
      
      Reviewers: #bitcoin_abc, deadalnix
      
      Reviewed By: #bitcoin_abc, deadalnix
      
      Differential Revision: https://reviews.bitcoinabc.org/D5138
      da6827e9
  13. 09 Jan, 2020 1 commit
    • TRuck's avatar
      Added guide for OSX users on how to install clang-format-8. · 55577b24
      TRuck authored
      Summary: Added the command that allowed me to use clang-format-8 without having to recompile llvm & clang to CONTRIBUTING.md.
      
      Test Plan: I ran `npm install -g clang-format@1.2.4`. I had to delete/move some files due to conflicts with another installation, but after that, running `arc diff` succeeded. A fresh installation should work with just that command; otherwise the instructions can be amended to accomodate for additional problems.
      
      Reviewers: deadalnix, O1 Bitcoin ABC, #bitcoin_abc, Fabien
      
      Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, Fabien
      
      Subscribers: Fabien
      
      Differential Revision: https://reviews.bitcoinabc.org/D4862
      55577b24
  14. 07 Jan, 2020 1 commit
  15. 17 Dec, 2019 1 commit
    • Fabien's avatar
      [DOC] Update build documentation and contributing to use cmake and ninja · 989e2275
      Fabien authored
      Summary:
      Includes some fixes and refreshes here and there.
      All these instructions have been tested working on the following
      platforms:
       - FreeBSD 12.0
       - MacOS Catalina 10.15.1
       - Ubuntu Bionic 18.04 (WSL)
       - Debian Buster (10)
       - Fedora 31
      
      Test Plan: Read the documents, follow the instructions and check it works !
      
      Reviewers: #bitcoin_abc, deadalnix, jasonbcox
      
      Reviewed By: #bitcoin_abc, jasonbcox
      
      Subscribers: jasonbcox
      
      Differential Revision: https://reviews.bitcoinabc.org/D4748
      989e2275
  16. 05 Dec, 2019 1 commit
  17. 26 Nov, 2019 1 commit
  18. 25 Nov, 2019 1 commit
  19. 28 Aug, 2019 1 commit
  20. 25 Jul, 2019 1 commit
  21. 13 Jul, 2019 1 commit
  22. 24 Jun, 2019 1 commit
  23. 06 Jun, 2019 1 commit
  24. 07 Apr, 2019 1 commit
    • Mengerian's avatar
      Remove communication style article from CONTRIBUTING.md · fd941e69
      Mengerian authored
      Summary:
      Although the article may be useful as general advice, it seems out of place with the other articles.
      It's better to keep these articles focused on specific development-style information that people may not easily find elsewhere.
      
      Test Plan: N/A
      
      Reviewers: deadalnix, #bitcoin_abc
      
      Reviewed By: deadalnix, #bitcoin_abc
      
      Subscribers: schancel
      
      Differential Revision: https://reviews.bitcoinabc.org/D2781
      fd941e69
  25. 06 Apr, 2019 1 commit
  26. 18 Feb, 2019 1 commit
    • Mark Lundeberg's avatar
      CONTRIBUTING.md : recommend ccache · dde1e30c
      Mark Lundeberg authored
      Summary:
      Both florian and I were late to the ccache thing and when we finally
      started using it, we were very pleased with the results. For new contibutors
      this is a helpful tip.
      
      Test Plan: none
      
      Reviewers: #bitcoin_abc, deadalnix, Mengerian
      
      Reviewed By: #bitcoin_abc, Mengerian
      
      Subscribers: Mengerian, teamcity, schancel
      
      Differential Revision: https://reviews.bitcoinabc.org/D2554
      dde1e30c
  27. 31 Jan, 2019 1 commit
    • Fabien's avatar
      Check for unused imports in *.py files · df298ba4
      Fabien authored
      Summary:
      Using flake8 code F401, unused imports are output as lint errors from
      acanist.
      flake8 is preferred here over pylint because it offers more feature for
      the long-term improvement. It could also throw pep8 errors but will not
      fix them like autopep8 does, so better use both.
      
      Based on core PR11835
      
      Depends on D2445, D2446, D2447, D2448, D2449, D2450
      
      Test Plan:
      Add an unused import in a py file and run `arc lint`. An error should be
      reported
      Read the CONTRIBUTING.md doc
      
      Reviewers: #bitcoin_abc, deadalnix, jasonbcox
      
      Reviewed By: #bitcoin_abc, jasonbcox
      
      Subscribers: teamcity, schancel
      
      Differential Revision: https://reviews.bitcoinabc.org/D2451
      df298ba4
  28. 19 Jan, 2019 1 commit
    • Mengerian's avatar
      Update CONTRIBUTING.md to clang-7 · 0f768b4a
      Mengerian authored
      Summary: Also add apt package link
      
      Test Plan: I used the apt.llvm.org source to install clang-7 in Ubuntu, and it worked.
      
      Reviewers: Fabien, deadalnix, jasonbcox, #bitcoin_abc
      
      Reviewed By: deadalnix, #bitcoin_abc
      
      Subscribers: markblundeberg, teamcity, schancel
      
      Differential Revision: https://reviews.bitcoinabc.org/D2343
      0f768b4a
  29. 11 Dec, 2018 1 commit
  30. 08 Dec, 2018 1 commit
  31. 07 Dec, 2018 1 commit
  32. 27 Nov, 2018 1 commit
  33. 07 Nov, 2018 1 commit
  34. 25 Jul, 2018 1 commit
  35. 05 Jun, 2018 1 commit
    • Mengerian's avatar
      Fix brackets in CONTRIBUTING.md · 1f6b3793
      Mengerian authored
      Summary: Markdown link had the wrong kind of brackets. This fixes them.
      
      Test Plan: Check that the link displays properly in Markdown viewer
      
      Reviewers: deadalnix, schancel, jasonbcox, #bitcoin_abc
      
      Reviewed By: deadalnix, #bitcoin_abc
      
      Subscribers: teamcity
      
      Differential Revision: https://reviews.bitcoinabc.org/D1475
      1f6b3793
  36. 23 Apr, 2018 1 commit
  37. 18 Apr, 2018 1 commit
    • Mengerian's avatar
      Add comment on fixing bugs to CONTRIBUTING.md · dbb2998a
      Mengerian authored
      Summary:
      Based on Amaury's comments in Dev Slack channel
      Explain that development process prioritizes fixing bugs when found, above other tasks
      
      Test Plan: Amaury should check that the wording reflects how he wants the process to work
      
      Reviewers: deadalnix, schancel, jasonbcox, #bitcoin_abc
      
      Reviewed By: jasonbcox, #bitcoin_abc
      
      Subscribers: teamcity
      
      Differential Revision: https://reviews.bitcoinabc.org/D1294
      dbb2998a
  38. 10 Apr, 2018 1 commit
  39. 14 Mar, 2018 1 commit
  40. 22 Feb, 2018 1 commit