Skip to content

Suggestion to add file CONTRIBUTING.md #439

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

Closed
leftkats opened this issue Jun 6, 2025 · 2 comments · Fixed by #441
Closed

Suggestion to add file CONTRIBUTING.md #439

leftkats opened this issue Jun 6, 2025 · 2 comments · Fixed by #441
Assignees

Comments

@leftkats
Copy link
Contributor

leftkats commented Jun 6, 2025

Hi 👋

Is your feature request related to a problem? Please describe.
I noticed the repository contains a file named contributions.md, but GitHub’s official contribution page at /contribute does not display any contribution guidelines. Because of this, new contributors might miss important instructions on how to contribute properly.

Describe the solution you'd like
It would be great to rename or add a properly named CONTRIBUTING.md file in the root of the repository. GitHub automatically detects this filename and displays it on the /contribute page, making contribution guidelines more visible and accessible.

Describe alternatives you've considered
Currently, contributors have to search through the repo or open issues to understand contribution rules, which is less efficient. Adding the properly named file is the standard and easiest solution.

Additional context
Example of a repo with CONTRIBUTING.md file

@DhanushNehru thanks for this great project, I've found it really interesting!

@DhanushNehru
Copy link
Owner

Sure @leftkats make sure it's updated properly and verified

@leftkats
Copy link
Contributor Author

leftkats commented Jun 6, 2025

Hello @DhanushNehru, I've created a pull request about this #441

feel free to adjust if needed 🚀

DhanushNehru added a commit that referenced this issue Jun 7, 2025
doc: contribution guidelines 📓 fixes issue #439
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 a pull request may close this issue.

2 participants