Skip to content

Commit 7df5405

Browse files
committed
Knots branding for README and GitHub issue templates
1 parent a1def19 commit 7df5405

File tree

10 files changed

+58
-133
lines changed

10 files changed

+58
-133
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ body:
55
- type: markdown
66
attributes:
77
value: |
8-
## This issue tracker is only for technical issues related to Bitcoin Core.
8+
## This issue tracker is only for technical issues related to Bitcoin Knots.
99
1010
* General bitcoin questions and/or support requests should use Bitcoin StackExchange at https://bitcoin.stackexchange.com.
11-
* For reporting security issues, please read instructions at https://bitcoincore.org/en/contact/.
11+
* For reporting security issues, please read instructions at https://bitcoinknots.org/contact/
1212
* If the node is "stuck" during sync or giving "block checksum mismatch" errors, please ensure your hardware is stable by running `memtest` and observe CPU temperature with a load-test tool such as `linpack` before creating an issue.
13+
* If your issue also affects Bitcoin Core, report it at https://github.com/bitcoin/bitcoin/issues/new?labels=bug&template=bug.yml
1314
1415
----
1516
- type: checkboxes
@@ -57,7 +58,7 @@ body:
5758
required: false
5859
- type: dropdown
5960
attributes:
60-
label: How did you obtain Bitcoin Core
61+
label: How did you obtain Bitcoin Knots
6162
multiple: false
6263
options:
6364
- Compiled from source
@@ -67,10 +68,10 @@ body:
6768
validations:
6869
required: true
6970
- type: input
70-
id: core-version
71+
id: knots-version
7172
attributes:
72-
label: What version of Bitcoin Core are you using?
73-
description: Run `bitcoind --version` or in Bitcoin-QT use `Help > About Bitcoin Core`
73+
label: What version of Bitcoin Knots are you using?
74+
description: Run `bitcoind --version` or in Bitcoin-QT use `Help > About Bitcoin Knots`
7475
placeholder: e.g. v24.0.1 or master@e1bf547
7576
validations:
7677
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: Bitcoin Core Security Policy
4-
url: https://github.com/bitcoin/bitcoin/blob/master/SECURITY.md
3+
- name: Bitcoin Knots Security Policy
4+
url: https://bitcoinknots.org/contact/
55
about: View security policy
6-
- name: Bitcoin Core Developers
7-
url: https://bitcoincore.org
8-
about: Bitcoin Core homepage
6+
- name: Bitcoin Knots Website
7+
url: https://bitcoinknots.org
8+
about: User-oriented information

.github/ISSUE_TEMPLATE/good_first_issue.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/gui_issue.yml

Lines changed: 0 additions & 18 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<!--
22
*** Please remove the following help text before submitting: ***
33
4-
Pull requests without a rationale and clear improvement may be closed
5-
immediately.
4+
Before opening a pull request to Bitcoin Knots, please first consider if it
5+
is appropriate for Bitcoin Core and, if so, rebase it and [open a pull request](https://github.com/bitcoin/bitcoin/compare)
6+
there first! Bitcoin Core has a strict and slow review process, but since
7+
Knots is more relaxed, feel free to request a merge of your Core PR into
8+
Knots even while it's waiting on Core.
69
7-
GUI-related pull requests should be opened against
8-
https://github.com/bitcoin-core/gui
9-
first. See CONTRIBUTING.md
1010
-->
1111

1212
<!--
1313
Please provide clear motivation for your patch and explain how it improves
14-
Bitcoin Core user experience or Bitcoin Core developer experience
14+
Bitcoin Knots user experience or Bitcoin Knots developer experience
1515
significantly:
1616
1717
* Any test improvements or new tests that improve coverage are always welcome.
@@ -22,22 +22,7 @@ significantly:
2222
* Bug fixes are most welcome when they come with steps to reproduce or an
2323
explanation of the potential issue as well as reasoning for the way the bug
2424
was fixed.
25-
* Features are welcome, but might be rejected due to design or scope issues.
26-
If a feature is based on a lot of dependencies, contributors should first
27-
consider building the system outside of Bitcoin Core, if possible.
28-
* Refactoring changes are only accepted if they are required for a feature or
29-
bug fix or otherwise improve developer experience significantly. For example,
30-
most "code style" refactoring changes require a thorough explanation why they
31-
are useful, what downsides they have and why they *significantly* improve
32-
developer experience or avoid serious programming bugs. Note that code style
33-
is often a subjective matter. Unless they are explicitly mentioned to be
34-
preferred in the [developer notes](/doc/developer-notes.md), stylistic code
35-
changes are usually rejected.
36-
-->
37-
38-
<!--
39-
Bitcoin Core has a thorough review process and even the most trivial change
40-
needs to pass a lot of eyes and requires non-zero or even substantial time
41-
effort to review. There is a huge lack of active reviewers on the project, so
42-
patches often sit for a long time.
25+
* Features are typically welcome.
26+
* Refactoring changes are never accepted in Knots, and must be performed in
27+
Bitcoin Core.
4328
-->

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Contributing to Bitcoin Core
2-
============================
1+
Contributing to Bitcoin Knots
2+
=============================
33

4-
The Bitcoin Core project operates an open contributor model where anyone is
4+
The Bitcoin Knots project operates an open contributor model where anyone is
55
welcome to contribute towards development in the form of peer review, testing
66
and patches. This document explains the practical process and guidelines for
77
contributing.
88

9-
First, in terms of structure, there is no particular concept of "Bitcoin Core
9+
First, in terms of structure, there is no particular concept of "core
1010
developers" in the sense of privileged people. Open source often naturally
1111
revolves around a meritocracy where contributors earn trust from the developer
1212
community over time. Nevertheless, some hierarchy is necessary for practical
@@ -55,7 +55,7 @@ and is also an effective way to request assistance if and when you need it.
5555
Communication Channels
5656
----------------------
5757

58-
Most communication about Bitcoin Core development happens on IRC, in the
58+
Most communication about Bitcoin development happens on IRC, in the
5959
`#bitcoin-core-dev` channel on Libera Chat. The easiest way to participate on IRC is
6060
with the web client, [web.libera.chat](https://web.libera.chat/#bitcoin-core-dev). Chat
6161
history logs can be found
@@ -290,12 +290,12 @@ workload on reviewing.
290290
"Decision Making" Process
291291
-------------------------
292292

293-
The following applies to code changes to the Bitcoin Core project (and related
293+
The following applies to code changes to the Bitcoin Knots project (and related
294294
projects such as libsecp256k1), and is not to be confused with overall Bitcoin
295295
Network Protocol consensus changes.
296296

297-
Whether a pull request is merged into Bitcoin Core rests with the project merge
298-
maintainers.
297+
Whether a pull request is merged into Bitcoin Knots rests with the project merge
298+
maintainers and ultimately the project lead.
299299

300300
Maintainers will take into consideration if a patch is in line with the general
301301
principles of the project; meets the minimum standards for inclusion; and will

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
1-
Bitcoin Core integration/staging tree
2-
=====================================
1+
Bitcoin Knots
2+
=============
33

4-
https://bitcoincore.org
4+
https://bitcoinknots.org
55

6-
For an immediately usable, binary version of the Bitcoin Core software, see
7-
https://bitcoincore.org/en/download/.
6+
For an immediately usable, binary version of the Bitcoin Knots software, see
7+
the website.
88

9-
What is Bitcoin Core?
10-
---------------------
9+
What is Bitcoin Knots?
10+
----------------------
1111

12-
Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully
12+
Bitcoin Knots connects to the Bitcoin peer-to-peer network to download and fully
1313
validate blocks and transactions. It also includes a wallet and graphical user
1414
interface, which can be optionally built.
1515

16-
Further information about Bitcoin Core is available in the [doc folder](/doc).
16+
Further information about Bitcoin Knots is available in the [doc folder](/doc).
1717

1818
License
1919
-------
2020

21-
Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
21+
Bitcoin Knots is released under the terms of the MIT license. See [COPYING](COPYING) for more
2222
information or see https://opensource.org/licenses/MIT.
2323

2424
Development Process
2525
-------------------
2626

27-
The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be
28-
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
29-
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
27+
Development generally takes place as part of [Bitcoin Core](https://github.com/bitcoin/bitcoin), and is merged into
28+
Knots for each release.
3029

31-
The https://github.com/bitcoin-core/gui repository is used exclusively for the
32-
development of the GUI. Its master branch is identical in all monotree
33-
repositories. Release branches and tags do not exist, so please do not fork
34-
that repository unless it is for development reasons.
30+
Even if your pull request to Core is closed, or if your feature is not
31+
suitable for Core (eg, because it builds on a features not supported in Core;
32+
relies on centralised services; etc), it may still be eligible for inclusion
33+
in Bitcoin Knots. In this case, a pull request may be opened on the
34+
[Knots GitHub](https://github.com/bitcoinknots/bitcoin) for review and consideration.
35+
When accepted, you are expected to maintain the submitted branch in your own
36+
repository, and it will be automatically merged into new releases of Knots.
3537

36-
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md)
37-
and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md).
38+
Developer IRC can be found on Freenode at #bitcoin-dev.
3839

3940
Testing
4041
-------

build_msvc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To build Bitcoin Core from the command-line, it is sufficient to only install th
1111

1212
The "Desktop development with C++" workload must be installed as well.
1313

14-
Building with Visual Studio is an alternative to the Linux based [cross-compiler build](../doc/build-windows.md).
14+
Building Knots with Visual Studio is NOT supported, and it is recommended to instead use the Linux based [cross-compiler build](../doc/build-windows.md).
1515

1616

1717
Prerequisites

doc/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
Bitcoin Core
1+
Bitcoin Knots
22
=============
33

44
Setup
55
---------------------
6-
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
6+
Bitcoin Knots is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
77

8-
To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/download/).
8+
To download Bitcoin Knots, visit [bitcoinknots.org](https://bitcoinknots.org/).
99

1010
Running
1111
---------------------
12-
The following are some helpful notes on how to run Bitcoin Core on your native platform.
12+
The following are some helpful notes on how to run Bitcoin Knots on your native platform.
1313

1414
### Unix
1515

@@ -24,7 +24,7 @@ Unpack the files into a directory, and then run bitcoin-qt.exe.
2424

2525
### macOS
2626

27-
Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.
27+
Drag Bitcoin Knots to your applications folder, and then run Bitcoin Knots.
2828

2929
### Need Help?
3030

@@ -36,7 +36,7 @@ for help and more information.
3636

3737
Building
3838
---------------------
39-
The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
39+
The following are developer notes on how to build Bitcoin Knots on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
4040

4141
- [Dependencies](dependencies.md)
4242
- [macOS Build Notes](build-osx.md)

doc/README_windows.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Bitcoin Core
1+
Bitcoin Knots
22
=============
33

44
Intro
@@ -13,7 +13,7 @@ Setup
1313
-----
1414
Unpack the files into a directory and run bitcoin-qt.exe.
1515

16-
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network.
16+
Bitcoin Knots is the original Bitcoin client and it builds the backbone of the network.
1717
However, it downloads and stores the entire history of Bitcoin transactions;
1818
depending on the speed of your computer and network connection, the synchronization
1919
process can take anywhere from a few hours to a day or more.

0 commit comments

Comments
 (0)