Add templates for standardization of files in each WG #278
Conversation
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
|
Thanks Yash! The files right now contain a lot of instructions. Could they be changed so that they can be copy-pasted to a new repository without needing changes? |
|
Yes @GeorgLink, I think we can modify the templates so they have minimal instructions. I'll make the required changes. |
|
It would be great if any instructions we need would be outside the template. Maybe have instructions in handbook? |
|
Yes, the instructions can be moved to the handbook. I guess the templates should then only contain the skeletal structure. I think I need to clarify this, for the README.md we can have a skeletal structure with instructions in the handbook and for the CONTRIBUTING.md/code-of-conduct.md we can have a copy-paste version. Is that right? |
|
I agree with @GeorgLink |
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
|
@GeorgLink, I have made the changes as discussed. Could you please take a look? |
templates/CONTRIBUTING.md
Outdated
|
|
||
| Thank you for your interest in contributing :tada:! | ||
|
|
||
| The general contributing guidelines can be found in the [community handbook](page-yet-to-be-created) |
There was a problem hiding this comment.
For now, let's point to the chaoss/governance repo's Contributing guidelines
templates/WG-README.md
Outdated
| @@ -0,0 +1,83 @@ | |||
| # CHAOSS \<_wg-name_\> Working Group | |||
There was a problem hiding this comment.
| # CHAOSS \<_wg-name_\> Working Group | |
| # CHAOSS <wg-name> Working Group |
There was a problem hiding this comment.
Backslashes are required else the word gets omitted, removed underscores
templates/WG-README.md
Outdated
| ## License | ||
|
|
||
| - Link to the `LICENSE` file | ||
| - Copyright notice |
There was a problem hiding this comment.
Copyright (c) 201x - CHAOSS, a Linux Foundation Project
Signed-off-by: Yash Prakash <yash2002109@gmail.com> Co-authored-by: Georg J.P. Link <linkgeorg@gmail.com>
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
|
@GeorgLink, I have updated the files as per your suggestions and as finalized in the meet. Could you please take a look? |
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
Hi everyone,
As discussed in #277, I have created some templates that can serve as a guide on standardizing the files.
The templates are for the following files:
Signed-off-by: Yash Prakash yash2002109@gmail.com