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

docs: cleanup README #5174

Merged
merged 1 commit into from
Jun 27, 2024
Merged

docs: cleanup README #5174

merged 1 commit into from
Jun 27, 2024

Conversation

iuioiua
Copy link
Contributor

@iuioiua iuioiua commented Jun 27, 2024

No description provided.

design, documentation and implementation of the package are good and that
it is unlikely to undergo breaking changes in the future.
1. 100% documented, passing `deno doc --lint` checks and adhering to the
[documentation guidelines](https://github.com/denoland/deno_std/blob/main/.github/CONTRIBUTING.md#documentation).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've moved this section to #4600.

### Minimal Exports

Files are structured to minimize the number of dependencies they incur and the
amount of effort required to manage them, both for the maintainer and the user.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to ARCHITECTURE.md.

>=1.0.0 follow [Semantic Versioning](https://semver.org/), and package versions
<1.0.0 follow [this proposal](https://github.com/semver/semver/pull/923).
Package versions >=1.0.0 follow [Semantic Versioning](https://semver.org/), and
package versions <1.0.0 follow
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the moment, as we cut releases when we see fit.

@iuioiua iuioiua marked this pull request as ready for review June 27, 2024 08:32
@iuioiua iuioiua requested a review from kt3k as a code owner June 27, 2024 08:32
Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.34%. Comparing base (410053b) to head (8ef247a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5174   +/-   ##
=======================================
  Coverage   93.34%   93.34%           
=======================================
  Files         470      470           
  Lines       37939    37939           
  Branches     5391     5391           
=======================================
  Hits        35414    35414           
  Misses       2482     2482           
  Partials       43       43           

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

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

LGTM

@iuioiua iuioiua merged commit aaf09a8 into main Jun 27, 2024
15 checks passed
@iuioiua iuioiua deleted the readme-clean branch June 27, 2024 08:55
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.

2 participants