-
Notifications
You must be signed in to change notification settings - Fork 184
pySCG: template for contributing to the project #669
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The change aims to create a simple template for creating README files for Secure Coding Python Guides. By using the template, we can ensure that all of the rule descriptions follow the same format in regards to page sections, code examples, bibliography, etc. The template also contains the link to quoting reference guide we have decided to follow. The template should be mentioned on the landing page referenced in ossf#520 Signed-off-by: edanhub <[email protected]>
docs/Secure-Coding-Guide-for-Python/contribution/README_TEMPLATE.md
Outdated
Show resolved
Hide resolved
docs/Secure-Coding-Guide-for-Python/contribution/README_TEMPLATE.md
Outdated
Show resolved
Hide resolved
Hi @s19110 Will there be a CONTRIBUTING file? https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file I think we need a higher level instruction that explains the overall process and mentions this file? |
Hello @tommcd I believe we should create a CONTRIBUTING file and provide a link to this template in it. For now, though, I just wanted to create a skeleton page so that when we migrate the rules, it's done in a consistent way as soon as possible. I can try creating a CONTRIBUTING file in a separate PR after discussing how exactly it should be done. |
|
Signed-off-by: edanhub <[email protected]>
Signed-off-by: edanhub <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is very useful. As mentioned, this should be one piece of a general contribution guide.
2 approvals, merging to main |
The change aims to create a simple template for creating README files for Secure Coding Python Guides. By using the template, we can ensure that all of the rule descriptions follow the same format in regard to page sections, code examples, bibliography, etc. The template also contains the link to quoting reference guide we have decided to follow.
The template should be mentioned on the landing page referenced in #520