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

Suggesting changes in CONTRIBUTING.md #114

Open
3141roy opened this issue Oct 4, 2022 · 1 comment
Open

Suggesting changes in CONTRIBUTING.md #114

3141roy opened this issue Oct 4, 2022 · 1 comment
Assignees
Labels
hacktoberfest-accepted The contribution is valid for HacktoberFest 2022

Comments

@3141roy
Copy link
Contributor

3141roy commented Oct 4, 2022

For uploading Algorithms and Problems in general, the contributing.md file states :

"In your PR description, be sure to include screenshots that prove that your code works. You are also encouraged to give a small description of your code / doc."

However, I would recommend a minor addition of requiring everyone to mention the problem number in the file name when uploading solutions to Leetcode problems. In this way, it will be easier for contributors to identify if a problem is already submitted by another user or not.

Although most users are following this convention, adding them to the rules will help get rid of benefit of doubt.

Plus it will also reduce the effort of maintainers to verify if a problem was already updated by someone else, thus, increasing the effectiveness of the process.

If you find the suggestion beneficial, please do assign it, so I may change the contributing.md file in the required fashion.

@Jayanti2919
Copy link
Contributor

That's a great suggestion. Thanks!

@Jayanti2919 Jayanti2919 added the hacktoberfest-accepted The contribution is valid for HacktoberFest 2022 label Oct 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted The contribution is valid for HacktoberFest 2022
Projects
None yet
Development

No branches or pull requests

2 participants