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

Improve Contribution Guide #1563

Open
muhammadalmaskhan opened this issue Jan 29, 2025 · 5 comments
Open

Improve Contribution Guide #1563

muhammadalmaskhan opened this issue Jan 29, 2025 · 5 comments

Comments

@muhammadalmaskhan
Copy link
Contributor

The repository lacks a clear and structured CONTRIBUTING.md file. New contributors may find it difficult to understand how to get started, set up the project, follow coding standards, and submit pull requests.

Proposed Solution:

  • Create a CONTRIBUTING.md file in the root directory.

  • Include guidelines for setting up the development environment.

  • Provide step-by-step instructions for making contributions.

  • Mention any coding style or best practices to follow.

  • Explain the process for submitting pull requests and reporting issues.

  • Having a well-defined contribution guide will make it easier for new contributors to engage with the project effectively.

@hendhamdi
Copy link

Hello @maintainer, I've created this PR to address issue #1563. I've added a CONTRIBUTING.md file with detailed instructions for new contributors. Here's what I included:

  • Setting up the environment.
  • Steps for submitting a PR.
  • Best practices and guidelines for reporting issues.

I hope this aligns with your expectations. Please let me know if any adjustments are needed. Thank you!

@muhammadalmaskhan
Copy link
Contributor Author

Supper ,

thanks @hendhamdi .

@sammyhori
Copy link
Collaborator

sammyhori commented Feb 4, 2025

Thanks for the issue.

Just a word of advice: it's best to keep issues related to pull requests open until the pull requests are merged, as no changes have actually been made to the repository until that happens.

People can also link their pull request to the issue it's aiming to solve so this closing at merge occurs automatically. That can also allow a reviewer to assess the goal of the pull request and judge whether it has sufficiently satisfied the requirements.

@sammyhori sammyhori reopened this Feb 4, 2025
@sammyhori sammyhori linked a pull request Feb 4, 2025 that will close this issue
@muhammadalmaskhan
Copy link
Contributor Author

Thanks for the issue.

Just a word of advice: it's best to keep issues related to pull requests open until the pull requests are merged, as no changes have actually been made to the repository until that happens.

People can also link their pull request to the issue it's aiming to solve so this closing at merge occurs automatically. That can also allow a reviewer to assess the goal of the pull request and judge whether it has sufficiently satisfied the requirements.

Hi @sammyhori,

thanks for advise.

@Ipshita29
Copy link

Hi @maintainer can i help further to improve the contribution guide?

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.

4 participants