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

[DOC] Missing CONTRIBUTING.md #43

Open
naman9271 opened this issue Feb 1, 2025 · 2 comments · May be fixed by #44
Open

[DOC] Missing CONTRIBUTING.md #43

naman9271 opened this issue Feb 1, 2025 · 2 comments · May be fixed by #44
Assignees

Comments

@naman9271
Copy link

Describe the issue
It appears that the repository does not include a CONTRIBUTING.md file. This file is essential to help guide contributors on how to report issues, propose features, and submit pull requests.

To Reproduce
Steps to reproduce the issue:

  1. Clone or browse the repository.
  2. Notice that there is no CONTRIBUTING.md file in the root or documentation folder.
  3. Realize that there are no clear contribution guidelines available.

Expected behavior
The repository should have a CONTRIBUTING.md file that outlines:

  • How to report bugs and request features.
  • The process for submitting pull requests.
  • Coding standards and commit message guidelines.
  • Other relevant details for community contributions.

Additional context
Adding a detailed CONTRIBUTING.md file will help new contributors understand how to effectively contribute to the project. This will reduce confusion and improve code quality. I have drafted a potential CONTRIBUTING.md file (see attached PR) for your review.

@naman9271 naman9271 linked a pull request Feb 1, 2025 that will close this issue
8 tasks
@naman9271
Copy link
Author

hey @Shubh942 please have a look i have created the contributing.md that's help in the ease of new contributors . Letme know if there will be need of some more changes.

@naman9271
Copy link
Author

@Shubh942 i have open a PR please review it

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.

1 participant