Skip to content
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

adds further reading for README #96

Merged
merged 2 commits into from
Mar 6, 2024

Conversation

clausmullie
Copy link
Member

@clausmullie clausmullie commented Nov 21, 2023

Closes #1 pending a good example or two

Works towards #27

#### Further reading

* [18Fs Open Source Guide on `README`s](https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md)
* [Jesse Luotos `README` best practices](https://github.com/jehna/readme-best-practices/)
Copy link
Contributor

Choose a reason for hiding this comment

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

If including this, maybe better to link directly to https://github.com/jehna/readme-best-practices/blob/master/README-default.md ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point

@clausmullie clausmullie marked this pull request as ready for review March 6, 2024 08:33
@clausmullie clausmullie requested a review from ericherman March 6, 2024 08:33
@clausmullie clausmullie merged commit 46bda1b into main Mar 6, 2024
2 checks passed
@clausmullie clausmullie deleted the adds-further-reading-for-READMEs branch March 6, 2024 08:36
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.

Adding good README files
2 participants