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

Add Annual Security Reports #2850

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jacobdjwilson
Copy link

@jacobdjwilson jacobdjwilson commented Nov 7, 2023

[[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

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
  • #2503,#2498
    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.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • βœ… Add Swift
    • βœ… Add Software Architecture
    • ❌ Update readme.md
    • ❌ Add Awesome Swift
    • ❌ Add swift
    • ❌ add Swift
    • ❌ Adding Swift
    • ❌ Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • βœ… - [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
  • Your entry should be added at the bottom of the appropriate category.
    Security
    This PR should add the entry to the readme.md
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Run 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?
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • βœ… Mobile operating system for Apple phones and tablets.
    • βœ… Prototyping interactive UI designs.
    • ❌ Resources and tools for iOS development.
    • ❌ Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • βœ… awesome-swift
    • βœ… awesome-web-typography
    • ❌ awesome-Swift
    • ❌ AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • βœ… # Awesome Swift
    • βœ… # Awesome Web Typography
    • ❌ # awesome-swift
    • ❌ # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
    How long does the group suggest aging out reports?
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired 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.

@sindresorhus
Copy link
Owner

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.

@jacobdjwilson
Copy link
Author

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.

Copy link
Author

@jacobdjwilson jacobdjwilson left a 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

Copy link

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

@jacobdjwilson
Copy link
Author

Thank you @roj1512 !! I think i've fixed the output of the lint run and your feedback on the contribution and title

@roj1512
Copy link

roj1512 commented Nov 16, 2023

@jacobdjwilson The title of this pull request is still not in the suggested format.

@jacobdjwilson jacobdjwilson changed the title Add Annual Security Reports to readme.md Add Annual Security Reports Nov 16, 2023
@jacobdjwilson
Copy link
Author

Gotcha, I've modified the PR title as well.

The one thing I can't seem to fix in awesome-lint is remark-lint:double-link
Some items in the list will link to the same vendor and may cause double links in this case.

@roj1512
Copy link

roj1512 commented Nov 17, 2023

@jacobdjwilson Above the line that is unreasonably failing, you can put this comment:

<!-- lint ignore double-link -->

@jacobdjwilson
Copy link
Author

Okay perfect, I put the ignore rule on line 1. We should be good to go now! I appreciate all the help!

@roj1512 roj1512 mentioned this pull request Nov 21, 2023
32 tasks
@sindresorhus
Copy link
Owner

The description starts with an uppercase character and ends with a period.

@sindresorhus
Copy link
Owner

For each item in the Analysis and Survey section, it would be useful with a one-sentence summary for each item. You can use ChatGPT for this.

I also think the report name column should be first.

@jacobdjwilson
Copy link
Author

@sindresorhus Is there any way to get this to pass the final failing lint check?

Copy link
Author

@jacobdjwilson jacobdjwilson left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants