Skip to content
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

📝 New rule - Do you use README templates? #9765

Conversation

Calinator444
Copy link
Member

  1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

✏️ It was originally an email from Seth but I lost it - It did say to seek approval from Matt before publishing this rule

  1. What was changed?

✏️I added a new rule about using README templates with examples of a gold, bronze and silver standard readme

  1. Did you do pair or mob programming (list names)?

✏️N/A - but I had the content checked by Tiago

@Calinator444 Calinator444 changed the title Create Rule “use-readme-templates/rule” 📝 New rule - Do you use README templates? Jan 10, 2025
@github-actions github-actions bot added Age: 🥚 - New About 2 hours old Age: 🐣 - Young About 4 hours old Age: 🐥 - Adolescent About 8 hours old and removed Age: 🥚 - New About 2 hours old Age: 🐣 - Young About 4 hours old labels Jan 10, 2025
Hey @Calinator444 

O fixed the Markdown for bad and good examples
Copy link
Member

@tiagov8 tiagov8 left a comment

Choose a reason for hiding this comment

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

Hey @Calinator444

  1. Please add this new rule to a category, so it's not orphaned
  2. Also add to related (back and forth): https://www.ssw.com.au/rules/awesome-readme/

@github-actions github-actions bot added Age: 🐤 - Mature About 16 hours old Age: 🐓 - Old About 32 hours old Age: 🍗 - Ancient About 64 hours old 🔥 Merge Debt This PR contains merge debt, see https://www.ssw.com.au/rules/merge-debt/ and removed Age: 🐥 - Adolescent About 8 hours old Age: 🐤 - Mature About 16 hours old Age: 🐓 - Old About 32 hours old labels Jan 10, 2025
Copy link
Contributor

Howzit @Calinator444,

This PR has been here a while.

Did you know you should avoid merge debt?

  1. Please action (e.g. get a review) and merge or close

Thanks!

@Calinator444
Copy link
Member Author

Hey @Calinator444

  1. Please add this new rule to a category, so it's not orphaned
  2. Also add to related (back and forth): https://www.ssw.com.au/rules/awesome-readme/

✅ Done - I added related links back and forth between this rule and the awesome readmes rule
I also put it in the same category as the awesome readmes rule.

@sethdaily
Copy link
Member

Hey @Calinator444
Good rule, thanks for doing it
Are those good examples an SSW GitHub readme template?

  1. Add the link to the template

@github-actions github-actions bot added the Age: 🦖 - Extinct About 128 hours old label Jan 13, 2025
@github-actions github-actions bot removed the Age: 🍗 - Ancient About 64 hours old label Jan 13, 2025
@tiagov8 tiagov8 requested a review from wicksipedia January 14, 2025 18:33
@uly1 uly1 enabled auto-merge (squash) January 24, 2025 02:01
@Calinator444
Copy link
Member Author

Hey @sethdaily

Hey @Calinator444 Good rule, thanks for doing it Are those good examples an SSW GitHub readme template?

  1. Add the link to the template

Done - I've made the readme template public and added a link in the rule

@wicksipedia wicksipedia requested a review from tiagov8 February 7, 2025 02:01
@wicksipedia wicksipedia disabled auto-merge February 7, 2025 02:01
Copy link
Member

@wicksipedia wicksipedia left a comment

Choose a reason for hiding this comment

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

test pass with changes

Calinator444 and others added 4 commits February 7, 2025 15:19
Co-authored-by: Matt Wicks [SSW] <wicksipedia@users.noreply.github.com>
Co-authored-by: Matt Wicks [SSW] <wicksipedia@users.noreply.github.com>
Co-authored-by: Matt Wicks [SSW] <wicksipedia@users.noreply.github.com>
Co-authored-by: Matt Wicks [SSW] <wicksipedia@users.noreply.github.com>
@Calinator444 Calinator444 enabled auto-merge (squash) February 7, 2025 04:20
@Calinator444 Calinator444 merged commit c71fdf8 into SSWConsulting:main Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Age: 🦖 - Extinct About 128 hours old 🔥 Merge Debt This PR contains merge debt, see https://www.ssw.com.au/rules/merge-debt/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants