From b0c5245cb505cecf57510227407099cd9b01e1ce Mon Sep 17 00:00:00 2001 From: Cameron Monagle Date: Tue, 12 May 2020 17:46:27 -0400 Subject: [PATCH 1/2] Example readme --- documentation/README.ex.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 documentation/README.ex.md diff --git a/documentation/README.ex.md b/documentation/README.ex.md new file mode 100644 index 0000000..21d4951 --- /dev/null +++ b/documentation/README.ex.md @@ -0,0 +1,34 @@ +# Repository title + +> Provides an example readme template to bootstrap documentation. + +Start with one sentence explaining what the repository does. Avoid mentioning the technology used, its rationale, or tech jargon. This sentence should be understandable by a non-technical audience. + +## Development + +Describe the development environment. Include basic instructions--does this repository prefer `npm ci` or `npm i`? Does prettier run on save? Any special settings or extensions you should set up in your IDE? + +If you're not sure where to start, consider explaining the npm scripts that might be relevent for getting a development environment + +## Dependencies + +Be sure to include any system level dependencies, even if they are shared with many projects. Do I need Transit APIs running? Redis? Docker? + +## Deployment + +How can I put this on staging or production? If automated, place a link to the cloud build trigger. + +## Organisation + +Include a quick overview of how the project is organised. If it follows a pattern, include a link to the Wikipedia article (ie: "This project is organised following the principles of [Domain Driven Design](), where it makes sense"). + +## Resources + +Are you consuming an entity that follows a documented specification? Include a link to the specification (ie gbfs or gtfs). + +## Final notes + +- Write in simple English. +- Prefer lists when appropriate. +- Include links to third party resources. + From ac2cdb57a492c03705ba7b14938930ecb81c2546 Mon Sep 17 00:00:00 2001 From: Cameron Monagle Date: Wed, 13 May 2020 10:35:41 -0400 Subject: [PATCH 2/2] Adds note on environment variables --- documentation/README.ex.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/README.ex.md b/documentation/README.ex.md index 21d4951..6481da9 100644 --- a/documentation/README.ex.md +++ b/documentation/README.ex.md @@ -8,6 +8,8 @@ Start with one sentence explaining what the repository does. Avoid mentioning th Describe the development environment. Include basic instructions--does this repository prefer `npm ci` or `npm i`? Does prettier run on save? Any special settings or extensions you should set up in your IDE? +Include any environment variables or configuration required. + If you're not sure where to start, consider explaining the npm scripts that might be relevent for getting a development environment ## Dependencies