What would be the best way to provide the templates? #33
Replies: 3 comments 1 reply
-
@AgainIoT/development-team |
Beta Was this translation helpful? Give feedback.
-
Contributing.mdThe way we currently offer templates for Contributing.md is a bit unusual. Or another way to personalize and provide templates of famous open sources. This, of course, makes it difficult to provide many templates. However, I think it will make the template easier to use. ETCI think the same goes for README and other templates... |
Beta Was this translation helpful? Give feedback.
-
Contributing.mdToday, Contributing.md categorized it into seven categories, but it was difficult to express all of the common Contributin.md . Therefore, I think it is better to provide a commonly used template such as readme.so as the next best option. At the same time, if you can offer multiple options within the same type, such as the style of Contributing.md within Open-Set-Go, I would like to recommend that you offer them like the Github Profile of readme.so . READMECurrently, README.md offers a well-known open source template, but since it's a difficult structure for individuals to customize, it's available in sections like readme.so , but I think it's a great way to increase options within sections. |
Beta Was this translation helpful? Give feedback.
-
Open-Set-Go provides not only the project itself, but also presets for popular issue template, PR template, README.md, and CONTRIBUTING.md. I have discussed with @ymw0407 about if providing only document presets like now would be helpful for users. The conclusion was "no".
We decided to provide categories for issue template presets, and PR template. And we agreed that it would be more helpful generating README.md and CONTRIBUTING.md for user's repository with project information than providing these documents included by existing repositories.
Check out the links below.
https://readme.so/
https://www.genreadme.cloud/
Beta Was this translation helpful? Give feedback.
All reactions