From dd4dcb5f951580072c9846c36376bbb375ed1e55 Mon Sep 17 00:00:00 2001 From: Jared Tobin Date: Wed, 28 Aug 2019 13:40:50 -0230 Subject: [PATCH] contributing: s/urbit/Urbit 'Urbit' refers to the project/product/platform, whereas 'urbit' refers to an individual ship or instance. This corrects some old, incorrect lower-case usage. --- CONTRIBUTING.md | 12 ++++++------ pkg/interface/CONTRIBUTING.md | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bd3f32f0..4450435c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ # Contributing to Urbit -Thank you for your interest in contributing to urbit. +Thank you for your interest in contributing to Urbit. See [urbit.org/docs/getting-started][start] for basic orientation and usage -instructions. You may also want to subscribe to [urbit-dev][list], the urbit -development mailing list. For specific information on contributing to the urbit +instructions. You may also want to subscribe to [urbit-dev][list], the Urbit +development mailing list. For specific information on contributing to the Urbit interface, see its [contribution guidelines][interface]. [start]: https://urbit.org/docs/getting-started/#arvo @@ -14,7 +14,7 @@ interface, see its [contribution guidelines][interface]. You may have an identity on the live network, but doing all your development on the live network would be cumbersome and unnecessary. Standard practice in -urbit development is to work on a fake `~zod`. Fake ships use deterministic +Urbit development is to work on a fake `~zod`. Fake ships use deterministic keys (derived from the ship address) and don't talk to the live network. They can talk to each other over the local loopback. @@ -137,7 +137,7 @@ Arvo, will find their way into releases before terribly long. ## Code style -The urbit project uses two-space indentation and avoids tab characters. +The Urbit project uses two-space indentation and avoids tab characters. In C code, it should not be too difficult to mimic the style of the code around you, which is just fairly standard K&R with braces on every compound statement. One thing to watch out for is top-level sections in @@ -210,7 +210,7 @@ $ git lfs pull The [GitHub tracker][issu] is our canonical source of truth around issues, bugs, performance problems, feature requests, and so on. If you encounter any -issues when developing on urbit, feel free to submit a report about it here. +issues when developing on Urbit, feel free to submit a report about it here. A good bug report, description of a crash, etc., should ideally be *reproducible*, with clear steps as to how another developer can replicate and diff --git a/pkg/interface/CONTRIBUTING.md b/pkg/interface/CONTRIBUTING.md index e2a60bc48..81564fdb7 100644 --- a/pkg/interface/CONTRIBUTING.md +++ b/pkg/interface/CONTRIBUTING.md @@ -1,6 +1,6 @@ ## Introduction -Thanks for your interest in contributing to the urbit interface. This section +Thanks for your interest in contributing to the Urbit interface. This section specifically focuses on Landscape development. Landscape lets you integrate your ship with front-end web applications accessed through the browser. It has a core set of applications that accept contributions. @@ -29,11 +29,11 @@ will make the production files and deposit them in [pkg/arvo][arvo]. Create a pull request with both the production files, and the source code you were working on in the interface directory. -Please also ensure your pull request fits our standards for +Please also ensure your pull request fits our standards for [Git hygiene][contributing]. -[contributing]: /CONTRIBUTING.md#git-practice -[arvo]: /pkg/arvo +[contributing]: /CONTRIBUTING.md#git-practice +[arvo]: /pkg/arvo [interface]:/pkg/interface ### Gall @@ -51,8 +51,8 @@ documentation for its everyday use -- just create a repo [using its template][template], install and then start it, and you'll soon be up and running. -[cla]: https://github.com/urbit/create-landscape-app -[template]: https://github.com/urbit/create-landscape-app/generate -[gall]: https://urbit.org/docs/learn/arvo/gall/ +[cla]: https://github.com/urbit/create-landscape-app +[template]: https://github.com/urbit/create-landscape-app/generate +[gall]: https://urbit.org/docs/learn/arvo/gall/ [chat]: /pkg/arvo/app/chat.hoon -[publish]: /pkg/arvo/app/publish.hoon \ No newline at end of file +[publish]: /pkg/arvo/app/publish.hoon