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.

Sign up for GitHub

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

Jump to bottom

Improve package descriptions in package.json files #2798

Open
2 tasks done
smallsaucepan opened this issue Dec 30, 2024 · 2 comments · May be fixed by #2802
Open
2 tasks done

Improve package descriptions in package.json files #2798

smallsaucepan opened this issue Dec 30, 2024 · 2 comments · May be fixed by #2802
Assignees
@protokoul
Labels
docs good-first-issue

Comments

@smallsaucepan
Copy link
Member

Many package.json files contain boilerplate descriptions like "turf name-of-the-package module".

More descriptive descriptions might help get the attention of potential new users. For example, it's the description field of package.json that appears as the subtitle in npmjs search results:

Screenshot 2024-12-30 at 11 39 22

Please provide the following when reporting an issue:

  • Description of the problem, and how it differs from what you expected.
  • Confirmation this issue hasn't already been reported, or is resolved and just hasn't been released yet.
@protokoul
Copy link

Hello. I would like to contribute here. I see that the API docs has nice descriptions that can be used here. Can I use them as is?

@smallsaucepan
Copy link
Member Author

Thanks for that @protokoul. Yes, definitely feel free to make use of the description in the API docs. Some of those are quite long though, so you may need to shorten them.

@protokoul protokoul linked a pull request Dec 31, 2024 that will close this issue
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@protokoul protokoul

Labels
docs good-first-issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update package.json for all turf packages protokoul/turf
2 participants
@smallsaucepan @protokoul