Conversation
There was a problem hiding this comment.
Thanks for the PR! I like this! Great idea to have templates in place.
However, may I suggest a few changes?
First, the existing documents in this repo are just guides, or documents. Not templates. I mean Licensing.md, Process.md, etc. Perhaps those should go under a docs/ folder instead of being at the top level?
Second, I don't think your suggested files to add should go under the .github directory at the top level, as those are reserved for the github-specific documents for this repo. Perhaps what could work instead is putting these new files into a top-level templates/ directory, with the (current) READMETemplate.md file then existing under templates/README.md, ContributingTemplate.md existing under templates/.github/CONTRIBUTING.md, etc.
Last but certainly not least, the repo's README should be updated to reflect any such changes, and the new documents should be explained / an overview of them should be provided and linked to as well.
What do you think?
|
Actually, one more thought here: we have a totally separate repo for templates, and that's over in https://github.com/adobe/starter-repo. Instead of housing templates in two locations, we should cross-link between these repos. And this PR, if you have specific content tweaks in mind, should recommend content changes over in that repo instead. |
|
We have open-development-template repo for projects that starts right away to adopt this method of working and starter-repo for projects that are defined right away as Open Source projects. Looks like the content and intent is pretty similar. Wondering if is a good idea to merge this effort into a single repo. I am going to add suggested modifications to the starter repo. There are a few important steps that needs to be captured when dealing with open development (how do you handle design decisions in a transparent way, specify a Style guideline for the project, How to file a bug, what is the timeframe to respond to PRs... ). Do you think this will work? |
Adding guided templates for opendev projects.