Skip to content

Add PackageReadmeFile.#888

Merged
Romfos merged 3 commits intonsubstitute:mainfrom
peymanr34:package-readme
Jul 13, 2025
Merged

Add PackageReadmeFile.#888
Romfos merged 3 commits intonsubstitute:mainfrom
peymanr34:package-readme

Conversation

@peymanr34
Copy link
Contributor

Added PackageReadmeFile to the project file.
https://learn.microsoft.com/en-us/nuget/reference/msbuild-targets#packagereadmefile

Before After
Before Image After Image

Copy link
Contributor

@304NotModified 304NotModified left a comment

Choose a reason for hiding this comment

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

Thanks!

(FYI I can approve PRs but not merge them)

@304NotModified
Copy link
Contributor

Maybe also update the changelog?

@Romfos
Copy link
Contributor

Romfos commented Jul 5, 2025

I think that package readme should be different from repo readme. Make sense to create this specifically for package

@304NotModified
Copy link
Contributor

@Romfos what do you think should be in the package readme and not in the repo readme and vice versa?

@peymanr34
Copy link
Contributor Author

Maybe also update the changelog?

Thanks, I've updated the changelog.

@Romfos
Copy link
Contributor

Romfos commented Jul 6, 2025

@Romfos what do you think should be in the package readme and not in the repo readme and vice versa?

I see package readme like:

  1. short section with information - what is it
  2. Tiny example of usage
  3. Links to this repo and documentation

readme for repo could have more info:

  • Build pipeline link & status
  • Nuget packages links
  • repo build guide
  • Alternatives & dependencies & congratulations
  • e.t.c

by this reason I think that it should be 2 separate files

@peymanr34
Copy link
Contributor Author

I've added a separate package readme file, please let me know if anything needs changing.

@Romfos Romfos self-requested a review July 11, 2025 22:56
@Romfos Romfos merged commit fcce009 into nsubstitute:main Jul 13, 2025
8 checks passed
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.

4 participants