maxmustermann/dogecoin
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
25757 commits 12 branches 161 tags 1.2 GiB
C++ 65.7%
Python 15%
C 12.5%
M4 2.7%
Makefile 1.5%
Other 2.5%
Go to file
MarcoFalke 38fd1bdcd4
Merge #18949: doc: Add CODEOWNERS file to automatically nominate PR reviewers 
a06eb03ded doc: Add comments and additional reviewers to CODEOWNERS file (Adam Jonas)
e02da22906 doc: Add CODEOWNERS file (Wladimir J. van der Laan)

Pull request description:

  This PR brings back and builds on #17094. GitHub uses a CODEOWNERS magic file to automatically add tagged contributors to the "Reviewers" list for a PR.

  The goal of this is to make use of GitHub's suggested reviewers feature and not to confer ownership or give veto power to specific people. It would be better if this file could be named CODEREVIEWERS, but alas, that wouldn't work. The idea of a NAGFILE was proposed in [Bitcoin Core Dev meeting in 2018](https://diyhpl.us/wiki/transcripts/bitcoin-core-dev-tech/2018-03-07-priorities/#:~:text=NAGFILE). While this GitHub implementation has some complications, it's a step towards realizing the promise of automating "reviewing begging" and (hopefully) positively impacting the review process as a whole.

  Of secondary value, this file can serve as documentation for who the maintainers are and who it might be smart to check with for certain areas of code/features (i.e., fuzzing, PSBT, and Bech32) -- this is helpful information for new contributors.

  * The first commit is taken from #17094
  * The second commit adds comments and expands the list of reviewers based on the suggestions and comments from that PR
  * ~The third WIP commit~ This commit also uses the doc dir as an example of granular assignments based on lines of codes ~contributed~ written and/or general engagement with the project. (If interested, here is a report for [most lines of code per author for each file](https://gist.github.com/adamjonas/854a46a1918224927b186865baeac411)). The pro of this level of detail is that the best reviewer is more likely to be nominated. The con is that it will create churn as files are renamed, new files are added, or reviewers want to be added or removed.

  Some open questions:
  * How often should this file be changed?
  * What level of history does one need have on the project before being added to this file? When does it make sense to remove a reviewer?
  * These review notifications can [cause a lot of noise](https://github.community/t5/How-to-use-Git-and-GitHub/Team-based-notifications-or-rework-CODEOWNERS-notification/td-p/7811) and automatically subscribes the requested reviewer to the thread. A GitHub Team based approach would allow for adding or removing reviewers without modifying this file; however, this comes along with its [own set of problems](https://bionic.fullstory.com/taming-github-codeowners-with-bots/#problems-with-github-code-owners), including granting [write access](https://github.community/t5/How-to-use-Git-and-GitHub/CODEOWNERS-works-with-users-but-not-teams/td-p/4986#U4991). Other projects [have used bots](https://bionic.fullstory.com/taming-github-codeowners-with-bots/#using-a-github-bot) to sidestep this.

Top commit has no ACKs.

Tree-SHA512: aa674ac62478b8801f48750df869c802070dc83d0fa9ff93596e9d63406129d7fd3c0daeb35d7a1a259554d045c24746a6808878a7b9867c7ed66d251f0c918f
2020-09-20 08:25:48 +02:00
.github doc: Remove label from good first issue template 2020-08-24 09:31:24 +02:00
.tx tx: Bump transifex slug to 020x 2020-03-16 10:52:55 +01:00
build-aux/m4 build: AX_PTHREAD serial 27 2020-09-14 16:35:09 +08:00
build_msvc Move Win32 defines to configure.ac to ensure they are globally defined 2020-08-20 17:55:06 +00:00
ci util: Hard code previous release tarball checksums 2020-08-29 11:28:53 +03:00
contrib Squashed 'src/secp256k1/' changes from 2ed54da18a..8ab24e8dad 2020-09-11 12:44:08 -07:00
depends Merge #19685: depends: CMake invocation cleanup 2020-09-02 21:03:05 +08:00
doc Merge #19940: rpc: Return fee and vsize from testmempoolaccept 2020-09-19 15:04:03 +08:00
share doc: Use precise permission flags where possible 2020-07-10 15:37:42 +02:00
src Merge #13686: ZMQ: Small cleanups in the ZMQ code 2020-09-19 17:13:28 +08:00
test Merge #19940: rpc: Return fee and vsize from testmempoolaccept 2020-09-19 15:04:03 +08:00
.appveyor.yml Update the vcpkg checkout commit ID in appveyor config. 2020-08-31 08:10:02 +01:00
.cirrus.yml ci: Double tsan CPU and Memory to avoid global timeout 2020-09-05 14:02:55 +02:00
.fuzzbuzz.yml ci: Add fuzzbuzz integration 2020-04-14 16:38:26 +00:00
.gitattributes
.gitignore Squashed 'src/secp256k1/' changes from 2ed54da18a..8ab24e8dad 2020-09-11 12:44:08 -07:00
.python-version
.style.yapf
.travis.yml Squashed 'src/secp256k1/' changes from 2ed54da18a..8ab24e8dad 2020-09-11 12:44:08 -07:00
autogen.sh scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
CODEOWNERS doc: Add comments and additional reviewers to CODEOWNERS file 2020-09-01 11:23:58 -04:00
configure.ac build: add PTHREAD_LIBS to LDFLAGS configure output 2020-09-14 16:12:36 +08:00
CONTRIBUTING.md Replace hidden service with onion service 2020-08-07 14:55:02 +02:00
COPYING
INSTALL.md
libbitcoinconsensus.pc.in
Makefile.am Squashed 'src/secp256k1/' changes from 2ed54da18a..8ab24e8dad 2020-09-11 12:44:08 -07:00
README.md doc: Mention repo split in the READMEs 2020-06-08 10:06:14 -04:00
SECURITY.md

README.md

Bitcoin Core integration/staging tree

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental digital currency that enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Bitcoin Core is the name of open source software which enables the use of this currency.

For more information, as well as an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the original whitepaper.

License

Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be completely stable. Tags are created regularly from release branches to indicate new official, stable release versions of Bitcoin Core.

The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: make check. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.

Translators should also subscribe to the mailing list.