-
-
Notifications
You must be signed in to change notification settings - Fork 28k
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
Add Semantic Commit #3283
base: main
Are you sure you want to change the base?
Add Semantic Commit #3283
Conversation
Thanks for making an Awesome list! 🙌 It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome. |
Hi @sindresorhus, Thank you for your feedback. I checked the checklist before opening this pull request, and everything seemed to comply with the guidelines. After receiving your feedback, I reviewed it again but couldn’t identify any missing points. When you have a moment, could you let me know what’s missing? I’ll make the necessary adjustments accordingly. Thanks in advance. |
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.
LGTM
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.
Thanks for creating the list!
In the guidelines, the description of a good list includes:
Does not include a CI (e.g. GitHub Actions) badge.
You have quite a lot of badges in your list. I think the language switch is ok, but "vercel: passed"? That's a CI badge.
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.
I only realized it when I looked at your list again - it's not a list. My understanding is that awesome lists are supposed to be lists of links to resources on a topic.
Your page is not a list, it's guide! Maybe the guide is awesome, but my gut feeling is it doesn't really qualify as an awesome list.
@lutzh, |
Yes, you are right, it's not a complete list, it's more of a guideline. However, I thought it might be useful under the Computer Science category, so I wanted to contribute. If it is not deemed appropriate, the owner of the awesome repo can close this pull request, which is fine with me. I'm also open to making changes if you or the repo owner can point out the points that need improvement without changing the purpose of the project. |
https://github.com/bozaci/awesome-semantic-commit
This list guides developers who want to implement the Semantic Commit Message rule. Semantic Commit messages make a project's version control history more organized, understandable and easy to follow. This list is meant to allow team members to adopt and apply these rules easily. In this way, code changes can be better categorized and Continuous Integration/Delivery (CI/CD) processes can be automated.
My Pull Requests Reviews
#3282
#2850
#3259
#3146
By submitting this pull request I confirm I've read and complied with the below requirements 🖖
Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.
Requirements for your pull request
Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions. Comments pointing out lint violation are allowed, but does not count as a review.
Add Name of List
. It should not contain the wordAwesome
.Add Swift
Add Software Architecture
Update readme.md
Add Awesome Swift
Add swift
add Swift
Adding Swift
Added Swift
- [iOS](…) - Mobile operating system for Apple phones and tablets.
- [Framer](…) - Prototyping interactive UI designs.
- [iOS](…) - Resources and tools for iOS development.
- [Framer](…)
- [Framer](…) - prototyping interactive UI designs
#readme
.- [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
Requirements for your Awesome list
That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
awesome-lint
on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.main
, notmaster
.Mobile operating system for Apple phones and tablets.
Prototyping interactive UI designs.
Resources and tools for iOS development.
Awesome Framer packages and tools.
If you have not put in considerable effort into your list, your pull request will be immediately closed.
awesome-name-of-list
.awesome-swift
awesome-web-typography
awesome-Swift
AwesomeWebTypography
# Awesome Name of List
.# Awesome Swift
# Awesome Web Typography
# awesome-swift
# AwesomeSwift
awesome-list
&awesome
as GitHub topics. I encourage you to add more relevant topics.Awesome X
and a logo withAwesome X
. You can put the header image in a#
(Markdown header) or<h1>
.Contents
, notTable of Contents
.Contributing
orFootnotes
sections.https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0
(replace<user>
and<repo>
accordingly).license
orLICENSE
in the repo root with the license text.Licence
section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.unicorn
.contributing.md
. The casing is up to you.Contributing
, positioned at the top or bottom of the main content.Footnotes
section at the bottom of the readme. The section should not be present in the Table of Contents.Example:
- [AVA](…) - JavaScript test runner.
Node.js
, notNodeJS
ornode.js
.You can still use a CI for linting, but the badge has no value in the readme.
Inspired by awesome-foo
orInspired by the Awesome project
kinda link at the top of the readme. The Awesome badge is enough.Go to the top and read it again.