mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Mention handling of "radicle.xyz"

This commit is contained in:
Lorenz Leutgeb 2025-08-28 14:03:05 +02:00 committed by Fintan Halpenny
parent 79505fa905
commit b301fa6a00
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -1,21 +1,21 @@
# CONTRIBUTING # CONTRIBUTING
Contributions are very welcome. Contributions are very welcome.
## Contributing Issues ## Contributing Issues
Contributing issues are an excellent way to ensure your problem will Contributing issues are an excellent way to ensure your problem will
eventually get looked at. eventually get looked at.
If creating an issue, please make sure to include: If creating an issue, please make sure to include:
- actual behaviour you're observing, - actual behaviour you're observing,
- the behaviour you were expecting instead, - the behaviour you were expecting instead,
- steps to reproduce your issue, - steps to reproduce your issue,
- the output of `rad debug`, - the output of `rad debug`,
- the contents of the log files referred to by that output. - the contents of the log files referred to by that output.
## Contributing Code ## Contributing Code
When contributing code, please follow these When contributing code, please follow these
simple guidelines. simple guidelines.
@ -180,6 +180,25 @@ for the reader:
for rid in self.storage.inventory()? { 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
independent 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 ### Proposing changes
When proposing changes via a patch: When proposing changes via a patch: