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

docs: Add LICENSE + CONTRIBUTING.md links to readme #14

Merged
merged 2 commits into from Oct 7, 2022

Conversation

shashankbhatgs
Copy link
Contributor

What's this PR do?

Add the links of LICENSE and CONTRIBUTING.md to the readme file so that it'll be easy to navigate while reading the readme file.

Checklist:

  • This pull request follows our contribution guidelines
  • I have performed a self-review of my own changes
  • I have made corresponding changes to the documentation

What is the current behavior?

Closes #13

README.md Outdated Show resolved Hide resolved
<br>
<p>
This project is Licensed under the <a href="./LICENSE">MIT License</a>. Please go through the License atleast once before making your contribution. </p>
<br>
Copy link
Member

Choose a reason for hiding this comment

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

Probably something like this is better

This project is Licensed under the [MIT License](./LICENSE). Please go through the License at least once before making your contribution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

123456


This is what is looks like if I made that change. I think it's because LICENSE is a folder and it's searching for a file inside LICENSE where infact there is none. Hence I left as it is. Please let me know if there's a way to resolve this.

README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

[DOCS] : Link License and Contributing.md to ReadMe
2 participants