Skip to content

Conversation

s19110
Copy link
Contributor

@s19110 s19110 commented Oct 17, 2024

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

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]>
@tommcd
Copy link
Contributor

tommcd commented Oct 23, 2024

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?

@s19110
Copy link
Contributor Author

s19110 commented Oct 23, 2024

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.

@myteron myteron changed the title Python guide: template for contributing to the project pySCG: template for contributing to the project Oct 24, 2024
@myteron
Copy link
Contributor

myteron commented Oct 24, 2024

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?
Hi @tommcd : I believe we should keep the scope small for this PR to just help our selfs. We need to do a proper page for contributors at some stage. For its enough for at least me to have just the template it self.

Copy link
Contributor

@gkunz gkunz left a 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.

@myteron
Copy link
Contributor

myteron commented Oct 25, 2024

2 approvals, merging to main

@myteron myteron closed this Oct 25, 2024
@myteron myteron reopened this Oct 25, 2024
@myteron myteron merged commit c2f296b into ossf:main Oct 25, 2024
3 checks passed
@s19110 s19110 deleted the pyDoc_Template branch October 31, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants