Guidelines for Writing Issues and PRs

[GarimaSingh0109]

Discussed in https://github.com/GarimaSingh0109/WasteManagment/discussions/131

^{Originally posted by **GarimaSingh0109** October 5, 2024} Dear Contributors, Thank you all for your contributions and hard work! To ensure smooth collaboration and help us maintain a high standard of quality, we kindly ask you to follow the guidelines below when creating issues and pull requests (PRs). **For Issues:** 1. Title: Clearly summarize the issue in one sentence. 2. Description: Provide a detailed explanation of the problem or feature request. Include any relevant context, screenshots, or links. 3. Steps to Reproduce (if applicable): Include steps to recreate the issue, along with expected vs. actual results. 4. Labels: Apply the appropriate labels to categorize the issue (bug, enhancement, question, etc.). **For Pull Requests:** 1. Title: Clearly state the purpose of the PR (e.g., “Fix issue #123” ). 2. Description: Describe the changes you made and why they are necessary. Link related issues. 3. Commit Messages: Write descriptive and concise commit messages. Each commit should explain what it accomplishes. 4. Review Checklist: Ensure your PR is thoroughly tested, and all required checks pass before submitting. 5. Documentation: If your PR changes any behavior, make sure relevant documentation is updated. 6. Following these guidelines will help us maintain a smooth workflow and ensure we catch and resolve issues efficiently. 7. Don't create pr untill the issue is assigned to you. Thank you for your attention and for contributing to our project. Let’s continue building great things together! Best regards, Garima Singh

[github-actions[bot]]

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.