Skip to content

Document build & test#284

Open
ashtonmeuser wants to merge 3 commits intonuskey8:mainfrom
ashtonmeuser:docs
Open

Document build & test#284
ashtonmeuser wants to merge 3 commits intonuskey8:mainfrom
ashtonmeuser:docs

Conversation

@ashtonmeuser
Copy link
Copy Markdown
Contributor

Simple docs re: building and testing. Contains info from #282 so opening this as a draft.

@ashtonmeuser ashtonmeuser marked this pull request as ready for review May 1, 2026 05:51
@ashtonmeuser
Copy link
Copy Markdown
Contributor Author

Requesting review now that #282 has landed.

@nuskey8
Copy link
Copy Markdown
Owner

nuskey8 commented May 1, 2026

This seems like something that should be placed in CONTRIBUTING.md, but what do you think?

@ashtonmeuser
Copy link
Copy Markdown
Contributor Author

I think that's your call and is fine either way. Personally, I'd lean to adding it to the README because the addition isn't overly long or detailed and the README is presented to users immediately (on GitHub, NuGet, etc.).

@nuskey8
Copy link
Copy Markdown
Owner

nuskey8 commented May 2, 2026

In my opinion, README files should be user-oriented documentation. This information is intended for developers and contributors, and is not something that general users need to be aware of.

@ashtonmeuser
Copy link
Copy Markdown
Contributor Author

@nuskey8, moved development docs to CONTRIBUTING.md and added a little general guidance preamble.

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.

2 participants