Skip to content

[FEATURE] Connect "Read The Contribution Guide" Button #674

@ArshiBansal

Description

@ArshiBansal

Is your feature request related to a problem? Please describe.

Currently, the "Read The Contribution Guide" button in contributors page is not connected to any page or resource. New contributors who want to learn how to contribute to the project do not have a clear path to access contribution guidelines, which may create confusion and increase the likelihood of inconsistent contributions.

Describe the solution you'd like

Connect the "Read The Contribution Guide" button to the repository's existing CONTRIBUTING.md file on GitHub.

If a dedicated contribution guidelines page is planned for the website in the future, the button can initially link to CONTRIBUTING.md and later be updated to point to the new page once it is created.

Describe alternatives you've considered

  • Creating a dedicated Contribution Guidelines page within the website and linking the button to that page.
  • Displaying contribution guidelines in a modal or popup instead of redirecting users.
  • Adding both options: a website contribution page that references the repository's CONTRIBUTING.md.

Additional context

This is a small usability improvement that can help onboard contributors more effectively and ensure they follow the project's contribution standards and code of conduct.

Suggested implementation:

  1. Short term: Link the button directly to the repository's CONTRIBUTING.md.
  2. Long term: Create a dedicated contribution guidelines page on the website and update the button to point there.

Metadata

Metadata

Assignees

Labels

gssoc26This is a official GirlScript Summer of Code label.level:beginnerBeginner level issuestype:docs

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions