Skip to content

Conversation

Copy link

Copilot AI commented Aug 25, 2025

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.

Copy link
Author

Copilot AI commented Aug 25, 2025

@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.

Copilot AI changed the title [WIP] Improve README.md for Better Project Discoverability Improve README.md for better project discoverability Aug 25, 2025
Copilot finished work on behalf of llucax August 25, 2025 08:27
Copilot AI requested a review from llucax August 25, 2025 08:27
Copy link
Contributor

@llucax llucax left a 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 just pip ... if you are adding pip commands. Also explain how to add the dependency in pyproject.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.

@copilot

Copy link
Author

Copilot AI commented Aug 25, 2025

  • If you add an installation guide use python3 -m pip ... instead of just pip ... if you are adding pip commands. Also explain how to add the dependency in pyproject.toml. Like (adapt as needed ...

I've updated the installation section to include proper version pinning guidance. The changes include:

  • Added a NOTE section explaining the difference between version pinning for programs (== 1.0.0) vs libraries (>= 1.0.0, < 2)
  • Used the latest release version (1.0.0) from the GitHub releases
  • Added reference to semantic versioning
  • Already using python3 -m pip command format as requested

The installation guide now provides clear guidance for both use cases while following semver best practices.

Copilot AI requested a review from llucax August 25, 2025 08:45
Copilot finished work on behalf of llucax August 25, 2025 08:45
Signed-off-by: Leandro Lucarella <[email protected]>
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
@github-actions github-actions bot added the part:docs Affects the documentation label Aug 25, 2025
@llucax llucax marked this pull request as ready for review August 25, 2025 10:15
@Copilot Copilot AI review requested due to automatic review settings August 25, 2025 10:15
@llucax llucax requested a review from a team as a code owner August 25, 2025 10:15
Copy link

Copilot AI left a 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, < 2 should 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.

@llucax llucax added the type:enhancement New feature or enhancement visitble to users label Aug 25, 2025
@llucax llucax requested a review from Marenz August 25, 2025 10:16
@llucax llucax enabled auto-merge August 25, 2025 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve README.md for Better Project Discoverability

2 participants