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 Web Performance Budget #1669

Merged
merged 4 commits into from Dec 24, 2019
Merged

Add Web Performance Budget #1669

merged 4 commits into from Dec 24, 2019

Conversation

@pajaydev
Copy link
Contributor

pajaydev commented Dec 4, 2019

https://github.com/pajaydev/awesome-web-performance-budget

Curated list of why, how and tools to implement Web Performance Budget. Included few cases studies which will be helpful to others.

PRs reviewed:
#1612
#1635

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 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.
    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.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • βœ… Add Swift
    • βœ… Add Software Architecture
    • ❌ Update readme.md
    • ❌ Add Awesome 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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=master&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 or text to the readme. GitHub already shows the license name 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.
  • 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.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't 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.

Go to the top and read it again.

Copy link
Contributor

MartinKavik left a comment

  • PR title hasn't required format.
  • We can't verify that you've read all the guidelines.
  • The license in the file is not acceptable and differs from the ones in readme and package.json.
  • Do not add the license name to the readme.
@MartinKavik MartinKavik mentioned this pull request Dec 4, 2019
@pajaydev pajaydev changed the title Adding Web performance budget Add Web performance budget Dec 4, 2019
@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 4, 2019

@MartinKavik I have updated the license and made the required changes.

@MartinKavik

This comment has been minimized.

Copy link
Contributor

MartinKavik commented Dec 5, 2019

@pajaydev

We can't verify that you've read all the guidelines.

One simple requirement still missing. Read guidelines again or you can review my PR and it will be clear :)

@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Dec 5, 2019

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.

@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 5, 2019

@sindresorhus Thanks for making this awesome πŸ˜„. Fixed couple of things and I ran the awesome-lint to check linting which passes πŸ’― percent. It would be great if you can review it again.

readme.md Outdated
@@ -289,6 +289,7 @@
- [Blazor](https://github.com/AdrienTorris/awesome-blazor#readme) - .NET web framework using C#/Razor and HTML that runs in the browser with WebAssembly.
- [Web Performance Metrics](https://github.com/csabapalfi/awesome-web-performance-metrics#readme) - Metrics to help understand page speed and user experience.
- [Tailwind CSS](https://github.com/aniftyco/awesome-tailwindcss#readme) - Utility-first CSS framework for rapid UI development.
- [Web Performance Budget](https://github.com/pajaydev/awesome-performance-budget#readme) - Curated list of why, how and tools to implement Web Performance Budget.

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Dec 8, 2019

Owner

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.

@sindresorhus sindresorhus changed the title Add Web performance budget Add Web Performance Budget Dec 8, 2019
pajaydev added 2 commits Dec 14, 2019
@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 14, 2019

@sindresorhus Changed the description as you requested. Kindly review.

readme.md Outdated Show resolved Hide resolved
@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Dec 16, 2019

Includes a succinct description of the project/theme at the top of the readme. (Example)

Not properly done.

@sindresorhus sindresorhus force-pushed the sindresorhus:master branch 3 times, most recently from 60790a6 to 26642b3 Dec 16, 2019
Co-Authored-By: Sindre Sorhus <sindresorhus@gmail.com>
@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 16, 2019

Includes a succinct description of the project/theme at the top of the readme. (Example)

Not properly done.

Changed it. Kindly take a look.

@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 22, 2019

@sindresorhus Is it good to merge ?. Kindly let me know if I need to make any changes.. Thanks a lot πŸ˜„

@sindresorhus

This comment has been minimized.

Copy link
Owner

sindresorhus commented Dec 22, 2019

The description in your awesome list readme needs to be longer. Elaborate on what a web performance budget is and why it's important.

Example: https://github.com/tokenmill/awesome-nlg#readme

@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 24, 2019

@sindresorhus Thanks. I have updated it as you suggested. Kindly verify https://github.com/pajaydev/awesome-web-performance-budget#readme

@sindresorhus sindresorhus merged commit 0d5eede into sindresorhus:master Dec 24, 2019
@sindresorhus

This comment has been minimized.

@pajaydev

This comment has been minimized.

Copy link
Contributor Author

pajaydev commented Dec 24, 2019

Thanks πŸ‘

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.