Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Linking License and Contributing Guidelines to the ReadMe #39

Closed
krupalitrivedi opened this issue Sep 27, 2022 · 2 comments
Closed

Linking License and Contributing Guidelines to the ReadMe #39

krupalitrivedi opened this issue Sep 27, 2022 · 2 comments

Comments

@krupalitrivedi
Copy link

Hello! When I was trying to find the Contributing Guidelines for the project, I was unable to find them.
It will be better if you change the directory of the file.

An example of how the Contributing file would be easy to navigate,
image

Along with that, I recommend linking guidelines and the license towards the end of the ReadMe file so it becomes easier for people on phones and computers as well to navigate easily!

@KyleTryon
Copy link
Contributor

Hey @krupalitrivedi 👋
Both relevant contributing docs are linked under the contributing section of the readme:
https://github.com/TechSquidTV/Shoutify#contributing

GitHub suggests placing the docs within either the root, (as you suggested), a docs directory (which we may use for product documentation in the future), or within the .github directory.

As the list of files in the root is growing quite large, pushing the readme farther down the page, I am attempting to move any file that does not need to be in the root, out of it currently, to give more room for the README.md, but all relevant links are within.

We are however missing the license as you mentioned, I'll get us a badge for the license 👍 . Thanks for the suggestion

@KyleTryon
Copy link
Contributor

License badge added: 553183a
Thank you!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants