-
Notifications
You must be signed in to change notification settings - Fork 4
Improve README.md for better project discoverability #76
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
base: v1.x.x
Are you sure you want to change the base?
Conversation
|
@llucax 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
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/)](<https://semver.org/>).
Make sure the structure/order of sections of the README should generally be:
- Introduction
- Supported Platforms
- Installation
- Quick Start
- Documentation (saying only something like “For complete API documentation, examples, and advanced usage patterns, see ”).
- Contributing
The amount and name of sections don’t have to match 100%, if there are already existing similar sections, leave them, but try to match the order above.
Please also check that the Supported Platforms section is up to date by checking which Python versions, operating systems (typically Ubuntu versions) and architectures are currently being tested by the CI GitHub workflow and update it if they are not up to date.
I've updated the installation section to include proper version pinning guidance. The changes include:
The installation guide now provides clear guidance for both use cases while following semver best practices. |
Signed-off-by: Leandro Lucarella <[email protected]> Co-authored-by: copilot-swe-agent[bot] <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the README.md file to improve project discoverability and onboarding by adding essential documentation sections. The changes provide clear guidance for new users on how to get started with the frequenz-quantities library.
- Added installation instructions for both pip and pyproject.toml dependency management
- Included a Quick Start section with practical code examples demonstrating basic usage
- Added versioning recommendations following semantic versioning best practices
Comments suppressed due to low confidence (1)
README.md:1
- The example version
>= 1.0.0, < 2should be updated to reflect actual available versions of the package to avoid confusion for users.
# Frequenz Quantities Library
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Enhanced the README.md file to improve onboarding experience for new users and contributors by adding missing essential sections about installation and quick start with a usage example.
Fixes #63.