Replace mySociety README with a GOV.UK specific one #3
Conversation
|
|
||
| - [Pinning to specific versions of Python dependencies](https://github.com/alphagov/mapit/pull/1), for reliability | ||
| - [Adding a Procfile](https://github.com/alphagov/mapit/pull/2), to standardise deployment with other apps | ||
| - [A GOV.UK specific README](https://github.com/alphagov/mapit/pull/2), to provide context for GOV.UK developers |
|
|
||
| ### Dependencies | ||
|
|
||
| MapIt has no depedencies on the rest of the GOV.UK stack, but does use PostgreSQL |
dsingleton
force-pushed
the
gds-readme
branch
2 times, most recently
from
d771769
to
4d1d9c6
Compare
|
|
||
| A web service to map postcodes to administrative boundaries and more. | ||
|
|
||
| MapIt was created and is maintained by [mySociety](https://github.com/mysociety/mapit) version, it's recommended you read their [README](https://github.com/mysociety/mapit/blob/master/README.rst) as well. |
There was a problem hiding this comment.
There's an extra word in this sentence: 'version' doesn't need to be there.
There was a problem hiding this comment.
Fixed
On 31 July 2015 at 14:40, Jenny Duckett notifications@github.com wrote:
In README.md
#3 (comment):@@ -0,0 +1,39 @@
+# MapIt
+
+A web service to map postcodes to administrative boundaries and more.
+
+MapIt was created and is maintained by mySociety version, it's recommended you read their README as well.There's an extra word in this sentence: 'version' doesn't need to be there.
—
Reply to this email directly or view it on GitHub
https://github.com/alphagov/mapit/pull/3/files#r35973806.
David Singleton
Cabinet Office, Government Digital Service
Developer, GOV.UK
david.singleton@digital.cabinet-office.gov.uk
For GOV.UK apps the README is usually a quick reference for developers who may not be familiar with the project. Add a new README that follows the GOV.UK README styleguide [1], aiming to orient those new to MapIt and its use in GOV.UK. The original (`.rst`) README was removed as GH still picks that over the new (`.md`) if both exist. To avoid confusion the new links to the old on the mySociety repo. [1]: https://github.com/alphagov/styleguides/
|
👍 |
Replace mySociety README with a GOV.UK specific one
- Although it's a very small nit to pick, I missed this in #3.
For GOV.UK apps the README is usually a quick reference for developers who
may not be familiar with the project.
Add a new README that follows the GOV.UK README styleguide 1, aiming to
orient those new to MapIt and its use in GOV.UK.
The original (
.rst) README was removed as GH still picks that over thenew (
.md) if both exist. To avoid confusion the new links to the oldon the mySociety repo.