From 9b2f0b0e122ebf13957b69e7fd34ba6a9cec571d Mon Sep 17 00:00:00 2001 From: Matilde Park Date: Mon, 31 Aug 2020 21:35:52 -0400 Subject: [PATCH] CONTRIBUTING: add link to maintainers in pkg/arvo Also removes a blurb about accepting emailed patches; this has never happened in practice, and we don't supply maintainers' emails. Sticking to what we know we support is best. --- CONTRIBUTING.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a1b08a2d..b64ef9c03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,14 @@ Thank you for your interest in contributing to Urbit. -See [urbit.org/docs/getting-started][start] for basic orientation and usage +See [urbit.org/using/install][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 interface, see its [contribution guidelines][interface]. -[start]: https://urbit.org/docs/getting-started/#arvo +For information on Arvo's maintainers, see [pkg/arvo][main]. + +[start]: https://urbit.org/using/install [interface]: /pkg/interface/CONTRIBUTING.md ## Fake ships @@ -45,11 +47,10 @@ The canonical source tree is the `master` branch of `master` when commencing new work; similarly, when we pull in your contribution, we'll do so by merging it to `master`. -Since we use GitHub, it's helpful (though not required) to contribute via a -GitHub pull request. You can also post patches to the [mailing list][list], -email them to maintainers, or request a maintainer pull from your tree directly --- but note that some maintainers will be more receptive to these methods than -others. +Since we use GitHub, we request you contribute via a GitHub pull request. Tag +the [maintainer][main] for the component. If you have a question for the +maintainer, you can direct message them from your Urbit ship using that +information. When contributing changes, via whatever means, make sure you describe them appropriately. You should attach a reasonably high-level summary of what the @@ -58,8 +59,8 @@ exist, e.g. a GitHub issue, a mailing list discussion, a UP, etc. [Here][jbpr] is a good example of a pull request with a useful, concise description. If your changes replace significant extant functionality, be sure to compare -them with the thing you're replacing. You may also want to cc maintainers, -reviewers, or other parties who might have a particular interest in what you're +them with the thing you're replacing. You may also want to cc reviewers, +or other parties who might have a particular interest in what you're contributing. [jbpr]: https://github.com/urbit/urbit/pull/1782 @@ -283,3 +284,4 @@ Questions or other communications about contributing to Urbit can go to [reba]: https://git-rebase.io/ [issu]: https://github.com/urbit/urbit/issues [hoon]: https://urbit.org/docs/learn/hoon/style/ +[main]: https://github.com/urbit/urbit/tree/master/pkg/arvo#maintainers \ No newline at end of file