Open BrianHGrant opened 5 years ago
Link to a start of a draft one:
The project i was using as a semi template had used rst, though I am not sure if there is a particular advantage to this: https://github.com/pydanny/cookiecutter-django
vs just going to markdown?
Is your feature request related to a problem? Please describe.
When creating an API backend project, it would be useful to have a standardized base template of information we have across projects in the readme. This would take out some of the guess work and time spent by developers when starting a Hack Oregon Project and ensure that projects can be traced back to source datasets, and have clear setup/development documentation
Describe the solution you'd like
I propose we create a readme template within the project repo which would pull in appropriate variables
A non-inclusive list of some areas which should be included:
Describe alternatives you've considered
Projects are left to organize readme without a clear guide. Information maybe missing or incomplete
Explain how this feature relates to your Hack Oregon project scope.
This adds to the strategic goal of standardized/maintainable APIs, and increases developer productivity
To clarify this will be the template readme for individual projects vs. the readme for cookiecutter template itself.