docs: Add README documentation to root and individual packages. #28
Conversation
![codecov[bot]](https://avatars.githubusercontent.com/in/254?s=60&v=4){kind=small}
There was a problem hiding this comment.
This review focuses on areas of the code changes where there might be a need for improvement or possible error. The changes generally improve the clarity of the Readme files, explaining what each plugin does, and provide effective examples for installation and usage. However, there are areas where we could further improve code quality by addressing hard-coding token values, using environment variables instead and ensuring consistency across the usage examples.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files
☔ View full report in Codecov by Sentry. |
|
|
||
| ```js | ||
| // rollup.config.js | ||
| import { defineConfig } from "rollup"; |
There was a problem hiding this comment.
The inclusion of the installation code for the plugins in the README is a useful guide for new users. It demonstrates a good practice for documentation.
| @@ -6,4 +6,52 @@ | |||
|
|
|||
| # Codecov Vite Plugin | |||
There was a problem hiding this comment.
The clarity and structure of information presented in this segment are commendable. Segregating the content into 'features', 'installation', and 'example usage' sections is a good practice for better user understanding.
| @@ -6,4 +6,26 @@ | |||
|
|
|||
| # Codecov Bundler Plugins | |||
|
|
|||
| TODO | |||
There was a problem hiding this comment.
Updating the 'TODO' comments with necessary information shows progress and is a positive change. It reflects the completion of a task and enhances the quality of the documentation.
|
|
||
| # Integration Tests | ||
|
|
||
| Each directory in the fixtures directory represents one testing scenario, with a corresponding test file for each bundler we currently support. |
There was a problem hiding this comment.
A brief description of the directory structure within the repository in the README file is a good practice for new developers to navigate the project more efficiently.
|
|
||
| In the `test-api` directory is a simple API that we use to create more realistic testing scenarios for each bundler. | ||
|
|
||
| In the `test-apps` directory are a set of apps that we use to test the integration with each bundler. |
There was a problem hiding this comment.
Documentation could be more elaborate about what the different apps in the 'test-apps' directory do and why they are vital for testing the integration with each bundler.
| > [!WARNING] | ||
| > These plugins are currently in alpha and are subject to change. | ||
|
|
||
| Codecov plugins for various JavaScript bundlers. Currently supporting Rollup, Vite, Webpack 5. |
There was a problem hiding this comment.
The active communication of the plugins being in alpha and subject to change is a critical piece of information. Consumers need this knowledge to anticipate future changes and handle unexpected problems if they arise.
| ## More information | ||
|
|
||
| - [Codecov Documentation](https://docs.codecov.com/docs) | ||
| - [Codecov Feedback](https://github.com/codecov/feedback/discussions) |
There was a problem hiding this comment.
The addition of feedback/discussion links and the Discord server link specialized for issues are very useful. It allows users to seek help when running into problems, providing a continuous feedback mechanism.
Description
This PR adds in documentation for each of the packages that we publish, as well as a root README for the project as a whole.
Notable changes