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 link to CONTRIBUTING.md in the main README.md #404

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vaishak10
Copy link

Description

In the readme file of the project provide a link to the contribution guidelines file.

Related Issue

README.md doesn't contain any link or reference to the contribution guidelines for the project.

Motivation and Context

The README.md file of the project does mention about the contributing guidelines to be followed for open-source contributions, but there was no certain link which redirects to this page. With the link inclusion it will be easier for the users to navigate to the CONTRIBUTING.md file.

Screenshots (In case of UI changes):

Before:
Screenshot 2022-10-01 at 5 18 04 PM
After:
Screenshot 2022-10-01 at 5 17 51 PM

Types of changes

[X] Documentation (Update the documentation page of the project)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Copy link
Contributor

@Abhijay007 Abhijay007 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

cc : @dinithminura @charithccmc

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