Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
doc: Mention handling of "radicle.xyz"
Lorenz Leutgeb committed 9 months ago
commit 1e61a56d11d1cc627e6031feb04d86466a506abf
parent 7b5174cdedb2c14e6911a88f39db07fdb3398556
1 file changed +19 -0
modified CONTRIBUTING.md
@@ -180,6 +180,25 @@ for the reader:
    for rid in self.storage.inventory()? {
        ...

+
### Referring to radicle.xyz in Code
+

+
While <https://radicle.xyz> is the main website of the project, and also the domain
+
associated with COBs implemented in this repo, we strive to write code that is as
+
indepent as reasonably possible from this particular domain name. For example, it
+
should not be used for default configuration values, or if it is, there should be a
+
way to override.
+

+
This makes it easier to re-package Radicle for distribution under a different domain
+
or fork it altogether. It also tends to produce better, more flexible, code.
+

+
In tests, instead use names that are compliant with RFC 2606, e.g.
+
"radicle.example.com".
+

+
Note that as of 2025-08, there are still a few mentions of "radicle.xyz" in the
+
codebase (mostly tests or user hints, fallback for configuration), and some of them
+
are not easy to remove. However, this is in no way a justification to add more
+
references.
+

### Proposing changes

When proposing changes via a patch: