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

Added information about Tidelift #147

Conversation

NilanchalaPanda
Copy link

PR Checklist

Overview

Fixes #47
Added information about what is Tidelift, and why it is used with an example of a company.
image

Copy link

codecov bot commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1492b5e) 95.62% compared to head (144b144) 95.62%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #147   +/-   ##
=======================================
  Coverage   95.62%   95.62%           
=======================================
  Files          12       12           
  Lines         343      343           
  Branches       30       30           
=======================================
  Hits          328      328           
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

A great start, thanks!

Don't forget to run the dev tooling locally - especially for formatter and linters. Looks like this PR has a couple issues 🙂.

https://github.com/JoshuaKGoldberg/tidelift-me-up/blob/a18f51b40a29564f95b192dbd154c026443e56f3/.github/DEVELOPMENT.md

Comment on lines +33 to +35

- Real life Example :
A Company that develops web applications using TypeScript and relies on various open-source libraries to enhance their development process. Instead of having to manage the maintenance and security of these open-source dependencies internally, the company subscribes to Tidelift. This subscription ensures that the open-source libraries they use are continuously maintained, updated, and supported by a team of professionals. This support allows the company to focus on their core development work, knowing that their open-source dependencies are in good hands and will be continuously improved and secured.
Copy link
Owner

Choose a reason for hiding this comment

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

[Proofreading] I don't think we need to provide quite so much explanation for what Tidelift is, when they already have their own docs (which aren't actually linked in this new explanation).

Suggested change
- Real life Example :
A Company that develops web applications using TypeScript and relies on various open-source libraries to enhance their development process. Instead of having to manage the maintenance and security of these open-source dependencies internally, the company subscribes to Tidelift. This subscription ensures that the open-source libraries they use are continuously maintained, updated, and supported by a team of professionals. This support allows the company to focus on their core development work, knowing that their open-source dependencies are in good hands and will be continuously improved and secured.

Copy link
Author

Choose a reason for hiding this comment

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

I thought a real life use case would help them understand better about the technology they'll using; but since they came till here to use it. I think that it is not essential to add this part. So it can be removed. Thank you so much for helping me out 😊

So now, should I do the required changes and again send a PR !?

Copy link
Owner

Choose a reason for hiding this comment

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

Cool! Yeah you can push commits to this same branch then re-request review: https://www.joshuakgoldberg.com/blog/contributing-to-a-create-typescript-app-repository/#re-requesting-review

Comment on lines +30 to +32
## What is Tidelift?

Tidelift is a platform that offers commercial support and maintenance for open-source software, including TypeScript. It works by providing a subscription-based service for companies and individual developers who use open-source projects. Tidelift partners with open-source maintainers to ensure that the software they provide is well-maintained, secure, and professionally supported.
Copy link
Owner

Choose a reason for hiding this comment

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

[Proofreading] Was this AI-authored? 🙂

including TypeScript

What does this mean? TypeScript is through Microsoft; Tidelift doesn't sponsor it.

I try to be as succinct in README explanations as possible. That way folks need to read through as little text as possible before they get to the really juicy stuff (how to use the tool). Any deeper explanations can be linked to.

What do you think about this?

Suggested change
## What is Tidelift?
Tidelift is a platform that offers commercial support and maintenance for open-source software, including TypeScript. It works by providing a subscription-based service for companies and individual developers who use open-source projects. Tidelift partners with open-source maintainers to ensure that the software they provide is well-maintained, secure, and professionally supported.
## What?
[Tidelift](https://tidelift.com) is a platform that distributes corporate sponsorships to open source maintainers in exchange for security and support guarantees.
`tidelift-me-up` finds which packages are eligible for [Tidelift "lifting"](https://tidelift.com/about/lifter) for a given npm username.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, the information that you have provided looks clean and to the point. Great for people just to know quickly what they will be working on 👍🏻

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author Needs an action taken by the original poster label Nov 14, 2023
@JoshuaKGoldberg
Copy link
Owner

👋 heya @NilanchalaPanda, just checking in - anything I can help with?

@JoshuaKGoldberg
Copy link
Owner

Closing this PR out as it's been a month without activity. Thanks for sending!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for author Needs an action taken by the original poster
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📝 Documentation: Mention what Tidelift does
2 participants