Skip to content

Conversation

@tommcd
Copy link
Contributor

@tommcd tommcd commented Apr 3, 2025

Fixes issue #839

Signed-off-by: emcdtho <[email protected]>
Copy link
Contributor

@s19110 s19110 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link fixes are fine. I added a suggestion for handling the invalid links in the README_TEMPLATE.md

@tommcd
Copy link
Contributor Author

tommcd commented Apr 9, 2025

Hi @s19110
While starting to edit the template I've noticed other issues: for example the bibliography example which we then explain is to be in Harvard style does not have the reference key in Harvard style, it should be "Python Software Foundation n.d.".
I think it would be clearer to give concrete examples with working links for the Related Guidelines, just copy from one of the existing articles? And finally i think we could add a little more explanation of how to use the template in the form of inline comments, for example:

<!-- 
Write your first sentence as a clear statement of the rule to be followed, such as 'Ensure that...' or 'Do not...'. 
The subsequent sentences in the introduction should provide context, motivation, and reasoning behind the rule.
-->

I think it's best to create a new issue for this.

@myteron myteron merged commit ed9675d into ossf:main Apr 10, 2025
2 checks passed
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.

3 participants