From de560b2fd9aa8a7b4ab94e8a359200b57b0a2436 Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 21 Nov 2023 15:02:18 +0100 Subject: [PATCH] adds further reading for README --- criteria/make-contributing-easy.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/criteria/make-contributing-easy.md b/criteria/make-contributing-easy.md index 8c588d7..96067e5 100644 --- a/criteria/make-contributing-easy.md +++ b/criteria/make-contributing-easy.md @@ -28,6 +28,12 @@ order: 5 In many platforms, like GitHub, GitLab, Gitea etc. these links are automatically provided in the interface. If you don't use the features of the platform, for example if you have a separate issue tracker, then you must provide these links. +#### Further reading + +* [18Fs Open Source Guide on `README`s](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md) +* [Jesse Luotos `README` best practices](https://github.com/jehna/readme-best-practices/) +* [`README`s for GOV.UK applications](https://docs.publishing.service.gov.uk/manual/readmes.html) + ### The codebase MUST have communication channels for users and developers, for example email lists. Preferably, anyone should be able to join these and start discussing without requiring an invite or other manual intervention.