-
-
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 Annual Security Reports #2850
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. |
To my knowledge the only requirement not fulfilled is linting. Is there someone that can help lint this? I don't see a clear set of directions here. Also this awesome list has existed for well over a year. |
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.
Add Annual Security Reports
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.
Hi, @jacobdjwilson. Here are some violations of the guidelines I’ve found while looking into your submission:
- Your pull request’s title is not in the suggested format.
- Your table of contents includes the “Contributing” section.
- awesome-lint fails: Your list items are neither consistent, nor following the guidelines.
Thank you @roj1512 !! I think i've fixed the output of the lint run and your feedback on the contribution and title |
@jacobdjwilson The title of this pull request is still not in the suggested format. |
Gotcha, I've modified the PR title as well. The one thing I can't seem to fix in awesome-lint is |
@jacobdjwilson Above the line that is unreasonably failing, you can put this comment: <!-- lint ignore double-link --> |
Okay perfect, I put the ignore rule on line 1. We should be good to go now! I appreciate all the help! |
|
For each item in the I also think the report name column should be first. |
c05ec08
to
bbe1e6f
Compare
@sindresorhus Is there any way to get this to pass the final failing lint check? |
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.
Please add Annual Security Reports
This review feedback is not addressed. You are also not following all the guidelines. |
It has been over six months since this PR was opened, and I am still unable to get the context to pass the linting checks for guidelines. Unfortunately, the feedback in your last post did not help move this PR forward. I disagree with listing the report title in the first column. If you review the dataset, you'll see that most reports are titled "Annual Threat Report." The Provider column is not only more unique but also allows users to quickly find multiple reports by relevant suppliers for their security programs. Additionally, using generic ChatGPT sentence summaries reduces the list’s usefulness. The most valuable context in those summaries is already included in the Data Type column. I have put a lot of thought into the structure and usability of this list, just as you have invested a lot of thought into the Awesome project as a whole. It would be great to get this PR merged. |
3bf1f46
to
f0658c5
Compare
@sindresorhus Okay I've reformatted all the data in list format and addressed your comments. Could you please review, thanks! |
@sindresorhus Could you please review the latest main branch of awesome-annual-security-reports? Thanks |
@rojvv I have changed the format of the main branch and moved the old format to a legacy branch. You were super helpful in previous comments helping with lint checks and I appreciate that, could you help with re-running the checks? Thank you! |
I helped because I had a PR of mine open back then, to fulfill its requirements. It is closed now and for the same reason I don't have a reason to help anymore. Sorry about that. |
There are several linting issues noted here. You can also run the lint command locally to check. For example, the error |
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.
Add Annual Security Reports
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.
Add Annual Security Reports
@sindresorhus Can this PR be merged please? Thanks |
The description should not start with the title. Applies in multiple places. |
Remove report titles from description and references to "the report" per PR comment for main Awesome repo. sindresorhus/awesome#2850 (comment)
I have removed all mention of report titles in the description and any references to "the report" or other circular references. |
[[Insert URL to the list here]]
(https://github.com/jacobdjwilson/awesome-annual-security-reports)
[Explain what this list is about and why it should be included here]
A curated list of annual cyber security reports.
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
Security
This PR should add the entry to the readme.md
#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.Can someone help me with this?
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.How long does the group suggest aging out reports?
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
. 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.I put other non-awesome inspirational people, does that count?
Go to the top and read it again.