-
Notifications
You must be signed in to change notification settings - Fork 6
Description
Hello team,
To improve the onboarding experience for new users and contributors, I'd suggest enhancing the README.md
file. A comprehensive README is crucial for a project's success.
Here are a few automated suggestions:
- A 'Quick Start' section is missing. This helps users get started immediately.
- Installation instructions or a dedicated '## Installation' section is missing.
A good README typically includes:
-
A clear project description.
-
A 'Quick Start' guide.
-
Detailed 'Installation' instructions.
-
Code examples.
-
A link to the full documentation.
-
The
Supported Platform
section should come before theInstallation
section. -
The markdown text should not exceed 80 columns (unless there is a long link or something like that).
-
If you add an installation guide use
python3 -m pip ...
instead of justpip ...
if you are adding pip commands. Also explain how to add the dependency inpyproject.toml
. Like (adapt as needed with the correct library name and use the latest github release to take the version number of the library when pinning/as the minimum dependency):```toml [project] dependencies = [ "<the-lib> >= 1.0.0, < 2", ] ``` > [!NOTE] > We recommend pinning the dependency to the latest version for programs, > like `"<the-lib> == 1.0.1"`, and specifying a version range spanning > one major version for libraries, like `"<the-lib> >= 1.0.1, < 2"`. > We follow [semver](https://semver.org/).
This is an automated message. Please close this issue if it's not relevant.