mirror of
https://github.com/dashpay/dash.git
synced 2024-12-24 19:42:46 +01:00
Merge #19072: doc: Expand section on Getting Started
facef3d4131f9980a4516282f11731361559509c doc: Explain that anyone can work on good first issues, move text to CONTRIBUTING.md (MarcoFalke) fae2fb2a196ee864e9a13fffc24a0279cd5d17e6 doc: Expand section on Getting Started (MarcoFalke) 100000d1b2c2e38d7a14a31b0af79e0e4316b04c doc: Add headings to CONTRIBUTING.md (MarcoFalke) fab893e0caf510d4836a20194892ef9c71426c51 doc: Fix unrelated typos reported by codespell (MarcoFalke) Pull request description: Some random doc changes: * Add sections to docs, so that they can be linked to * Explain that anyone (even maintainers) are allowed to work on good first issues * Expand section on Getting Started slightly ACKs for top commit: hebasto: ACK facef3d4131f9980a4516282f11731361559509c fanquake: ACK facef3d4131f9980a4516282f11731361559509c Tree-SHA512: 8998e273a76dbf4ca77e79374c14efe4dfcc5c6df6b7d801e1e1e436711dbe6f76b436f9cbc6cacb45a56827babdd6396f3bd376a9426ee7be3bb9b8a3b8e383
This commit is contained in:
parent
2da9982e55
commit
0eba155aa7
7
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
7
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
@ -9,6 +9,9 @@ assignees: ''
|
|||||||
|
|
||||||
<!-- Needs the label "good first issue" assigned manually before or after opening -->
|
<!-- Needs the label "good first issue" assigned manually before or after opening -->
|
||||||
|
|
||||||
|
<!-- A good first issue is an uncontroversial issue, that has a relatively unique and obvious solution -->
|
||||||
|
|
||||||
|
<!-- Motivate the issue and explain the solution briefly -->
|
||||||
|
|
||||||
#### Useful skills:
|
#### Useful skills:
|
||||||
|
|
||||||
@ -16,8 +19,4 @@ assignees: ''
|
|||||||
|
|
||||||
#### Want to work on this issue?
|
#### Want to work on this issue?
|
||||||
|
|
||||||
The purpose of the `good first issue` label is to highlight which issues are suitable for a new contributor without a deep understanding of the codebase.
|
|
||||||
|
|
||||||
You do not need to request permission to start working on this. You are encouraged to comment on the issue if you are planning to work on it. This will help other contributors monitor which issues are actively being addressed and is also an effective way to request assistance if and when you need it.
|
|
||||||
|
|
||||||
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/dashpay/dash/blob/master/CONTRIBUTING.md) before opening your pull request.
|
For guidance on contributing, please read [CONTRIBUTING.md](https://github.com/dashpay/dash/blob/master/CONTRIBUTING.md) before opening your pull request.
|
||||||
|
@ -14,9 +14,40 @@ purposes. As such there are repository "maintainers" who are responsible for
|
|||||||
merging pull requests as well as a "lead maintainer" who is responsible for the
|
merging pull requests as well as a "lead maintainer" who is responsible for the
|
||||||
release cycle, overall merging, moderation and appointment of maintainers.
|
release cycle, overall merging, moderation and appointment of maintainers.
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
---------------
|
||||||
|
|
||||||
|
New contributors are very welcome and needed.
|
||||||
|
|
||||||
|
Reviewing and testing is the most effective way you can contribute as a new
|
||||||
|
contributor, and it also will teach you much more about the code and process
|
||||||
|
than opening PRs. Please refer to the section [peer review](#peer-review) later
|
||||||
|
in this document.
|
||||||
|
|
||||||
|
Before you start contributing, familiarize yourself with the Dash Core build
|
||||||
|
system and tests. Refer to the documentation in the repository on how to build
|
||||||
|
Dash Core and how to run the unit and functional tests.
|
||||||
|
|
||||||
|
There are many open issues of varying difficulty waiting to be fixed.
|
||||||
If you're looking for somewhere to start contributing, check out the
|
If you're looking for somewhere to start contributing, check out the
|
||||||
[good first issue](https://github.com/dashpay/dash/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
[good first issue](https://github.com/dashpay/dash/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
||||||
list.
|
list.
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Good First Issue Label
|
||||||
|
|
||||||
|
The purpose of the `good first issue` label is to highlight which issues are
|
||||||
|
suitable for a new contributor without a deep understanding of the codebase.
|
||||||
|
|
||||||
|
However, good first issues can be solved by anyone. If they remain unsolved
|
||||||
|
for a longer time, a frequent contributor might address them.
|
||||||
|
|
||||||
|
You do not need to request permission to start working on an issue. However,
|
||||||
|
you are encouraged to leave a comment if you are planning to work on it. This
|
||||||
|
will help other contributors monitor which issues are actively being addressed
|
||||||
|
and is also an effective way to request assistance if and when you need it.
|
||||||
|
|
||||||
|
|
||||||
Contributor Workflow
|
Contributor Workflow
|
||||||
--------------------
|
--------------------
|
||||||
@ -34,6 +65,8 @@ To contribute a patch, the workflow is as follows:
|
|||||||
The project coding conventions in the [developer notes](doc/developer-notes.md)
|
The project coding conventions in the [developer notes](doc/developer-notes.md)
|
||||||
must be followed.
|
must be followed.
|
||||||
|
|
||||||
|
### Committing Patches
|
||||||
|
|
||||||
In general, [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
|
In general, [commits should be atomic](https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention)
|
||||||
and diffs should be easy to read. For this reason, do not mix any formatting
|
and diffs should be easy to read. For this reason, do not mix any formatting
|
||||||
fixes or code moves with actual code changes.
|
fixes or code moves with actual code changes.
|
||||||
@ -57,6 +90,8 @@ about Git.
|
|||||||
- Push changes to your fork
|
- Push changes to your fork
|
||||||
- Create pull request
|
- Create pull request
|
||||||
|
|
||||||
|
### Creating the Pull Request
|
||||||
|
|
||||||
Pull request titles should follow the Conventional Commits specification which
|
Pull request titles should follow the Conventional Commits specification which
|
||||||
uses the `<type>(optional scope): <description>` scheme. Please see the
|
uses the `<type>(optional scope): <description>` scheme. Please see the
|
||||||
specification linked below for valid types. When making a change to a specific
|
specification linked below for valid types. When making a change to a specific
|
||||||
@ -94,18 +129,24 @@ Examples:
|
|||||||
fix(log): fix typo in log message
|
fix(log): fix typo in log message
|
||||||
feat(rpc)!: modify gettransaction parameter type
|
feat(rpc)!: modify gettransaction parameter type
|
||||||
|
|
||||||
|
The body of the pull request should contain enough description about what the
|
||||||
|
patch does together with any justification/reasoning. You should include
|
||||||
|
references to any discussions (for example other tickets or mailing list
|
||||||
|
discussions).
|
||||||
|
|
||||||
|
### Translation changes
|
||||||
|
|
||||||
Note that translations should not be submitted as pull requests. Please see
|
Note that translations should not be submitted as pull requests. Please see
|
||||||
[Translation Process](https://github.com/dashpay/dash/blob/master/doc/translation_process.md)
|
[Translation Process](https://github.com/dashpay/dash/blob/master/doc/translation_process.md)
|
||||||
for more information on helping with translations.
|
for more information on helping with translations.
|
||||||
|
|
||||||
|
### Work in Progress Changes and Requests for Comments
|
||||||
|
|
||||||
If a pull request is not to be considered for merging (yet), please
|
If a pull request is not to be considered for merging (yet), please
|
||||||
prefix the title with [WIP] or use [Tasks Lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists)
|
prefix the title with [WIP] or use [Tasks Lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists)
|
||||||
in the body of the pull request to indicate tasks are pending.
|
in the body of the pull request to indicate tasks are pending.
|
||||||
|
|
||||||
The body of the pull request should contain enough description about what the
|
### Address Feedback
|
||||||
patch does together with any justification/reasoning. You should include
|
|
||||||
references to any discussions (for example other tickets or mailing list
|
|
||||||
discussions).
|
|
||||||
|
|
||||||
At this stage, one should expect comments and review from other contributors. You
|
At this stage, one should expect comments and review from other contributors. You
|
||||||
can add more commits to your pull request by committing them locally and pushing
|
can add more commits to your pull request by committing them locally and pushing
|
||||||
|
@ -38,7 +38,7 @@ static constexpr uint8_t PSBT_OUT_BIP32_DERIVATION = 0x02;
|
|||||||
static constexpr uint8_t PSBT_SEPARATOR = 0x00;
|
static constexpr uint8_t PSBT_SEPARATOR = 0x00;
|
||||||
|
|
||||||
// BIP 174 does not specify a maximum file size, but we set a limit anyway
|
// BIP 174 does not specify a maximum file size, but we set a limit anyway
|
||||||
// to prevent reading a stream indefinately and running out of memory.
|
// to prevent reading a stream indefinitely and running out of memory.
|
||||||
const std::streamsize MAX_FILE_SIZE_PSBT = 100000000; // 100 MiB
|
const std::streamsize MAX_FILE_SIZE_PSBT = 100000000; // 100 MiB
|
||||||
|
|
||||||
/** A structure for PSBTs which contain per-input information */
|
/** A structure for PSBTs which contain per-input information */
|
||||||
|
@ -346,7 +346,7 @@ void WalletView::gotoLoadPSBT()
|
|||||||
|
|
||||||
TransactionError result = BroadcastTransaction(*clientModel->node().context(), tx, err_string, DEFAULT_MAX_RAW_TX_FEE_RATE.GetFeePerK(), /* relay */ true, /* wait_callback */ false);
|
TransactionError result = BroadcastTransaction(*clientModel->node().context(), tx, err_string, DEFAULT_MAX_RAW_TX_FEE_RATE.GetFeePerK(), /* relay */ true, /* wait_callback */ false);
|
||||||
if (result == TransactionError::OK) {
|
if (result == TransactionError::OK) {
|
||||||
Q_EMIT message(tr("Success"), tr("Broadcasted transaction sucessfully."), CClientUIInterface::MSG_INFORMATION | CClientUIInterface::MODAL);
|
Q_EMIT message(tr("Success"), tr("Broadcasted transaction successfully."), CClientUIInterface::MSG_INFORMATION | CClientUIInterface::MODAL);
|
||||||
} else {
|
} else {
|
||||||
Q_EMIT message(tr("Error"), QString::fromStdString(err_string), CClientUIInterface::MSG_ERROR);
|
Q_EMIT message(tr("Error"), QString::fromStdString(err_string), CClientUIInterface::MSG_ERROR);
|
||||||
}
|
}
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||||
"""
|
"""
|
||||||
Test deprecation of the RPC getaddressinfo `label` field. It has been
|
Test deprecation of the RPC getaddressinfo `label` field. It has been
|
||||||
superceded by the `labels` field.
|
superseded by the `labels` field.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
from test_framework.test_framework import BitcoinTestFramework
|
from test_framework.test_framework import BitcoinTestFramework
|
||||||
|
Loading…
Reference in New Issue
Block a user