aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGabriel Pérez <[email protected]>2021-05-14 12:59:02 -0400
committerGabriel Pérez <[email protected]>2021-05-14 12:59:02 -0400
commit548ffd6ed2f90018aa97549a6fb5c33659c0f193 (patch)
treef036b3b381f0b4bcd4836255de9e97c148147934 /CONTRIBUTING.md
parentUpdating Dogecoin references in CONTRIBUTING (diff)
parentMerge pull request #1844 from pmzajaczkowski/fixing-polish-translations (diff)
downloaddiscoin-548ffd6ed2f90018aa97549a6fb5c33659c0f193.tar.xz
discoin-548ffd6ed2f90018aa97549a6fb5c33659c0f193.zip
Merge branch '1.14.4-dev' of github.com:dogecoin/dogecoin into remove-bitcoin-references
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md30
1 files changed, 13 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d1f01a07f..bbba03b2c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,4 @@
-Contributing to Dogecoin Core
-============================
+# Contributing to Dogecoin Core
The Dogecoin Core project operates an open contributor model where anyone is
welcome to contribute towards development in the form of peer review, testing
@@ -15,8 +14,7 @@ merging pull requests as well as a "lead maintainer" who is responsible for the
release cycle, overall merging, moderation and appointment of maintainers.
-Contributor Workflow
---------------------
+## Contributor Workflow
The codebase is maintained using the "contributor workflow" where everyone
without exception contributes patch proposals using "pull requests". This
@@ -94,8 +92,9 @@ 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
to your fork until you have satisfied all feedback.
-Squashing Commits
----------------------------
+
+## Squashing Commits
+
If your pull request is accepted for merging, you may be asked by a maintainer
to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
before it will be merged. The basic squashing workflow is shown below.
@@ -121,8 +120,7 @@ The length of time required for peer review is unpredictable and will vary from
pull request to pull request.
-Pull Request Philosophy
------------------------
+## Pull Request Philosophy
Patchsets should always be focused. For example, a pull request could add a
feature, fix a bug, or refactor code; but not a mixture. Please also avoid super
@@ -130,7 +128,7 @@ pull requests which attempt to do too much, are overly large, or overly complex
as this makes review difficult.
-###Features
+### Features
When adding a new feature, thought must be given to the long term technical debt
and maintenance that feature may require after inclusion. Before proposing a new
@@ -139,7 +137,7 @@ maintain it (including bug fixing). If features get orphaned with no maintainer
in the future, they may be removed by the Repository Maintainer.
-###Refactoring
+### Refactoring
Refactoring is a necessary part of any software project's evolution. The
following guidelines cover refactoring pull requests for the project.
@@ -154,8 +152,7 @@ Project maintainers aim for a quick turnaround on refactoring pull requests, so
where possible keep them short, uncomplex and easy to verify.
-"Decision Making" Process
--------------------------
+## "Decision Making" Process
The following applies to code changes to the Dogecoin Core project (and related
projects such as libsecp256k1), and is not to be confused with overall Dogecoin
@@ -187,7 +184,7 @@ other kinds of patches because of increased peer review and consensus building
requirements.
-###Peer Review
+### Peer Review
Anyone may participate in peer review which is expressed by comments in the pull
request. Typically reviewers will review the code for obvious errors, as well as
@@ -226,13 +223,12 @@ discussed BIP and have a generally widely perceived technical consensus of being
a worthwhile change based on the judgement of the maintainers.
-Release Policy
---------------
+## Release Policy
The project leader is the release manager for each Dogecoin Core release.
-Copyright
----------
+
+## Copyright
By contributing to this repository, you agree to license your work under the
MIT license unless specified otherwise in `contrib/debian/copyright` or at