From c7d1a46cfff4c4358a44449fe32f47088d4ccf5b Mon Sep 17 00:00:00 2001 From: Peter Harrison Date: Mon, 13 Mar 2023 20:17:17 -0700 Subject: [PATCH] Update ISSUE_GUIDELINES.md --- ISSUE_GUIDELINES.md | 46 ++++++++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 11 deletions(-) diff --git a/ISSUE_GUIDELINES.md b/ISSUE_GUIDELINES.md index a43372ba2..6c8bfe8cf 100644 --- a/ISSUE_GUIDELINES.md +++ b/ISSUE_GUIDELINES.md @@ -4,29 +4,53 @@ In order to give everyone a chance to submit a issues reports and contribute to the Talawa project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in the Talawa project. +___ +## Table of Contents + + +- [Issue Report Guidelines](#issue-report-guidelines) + - [Table of Contents](#table-of-contents) + - [Issue Management](#issue-management) + - [New Issues](#new-issues) + - [Existing Issues](#existing-issues) + - [Feature Request Issues](#feature-request-issues) + - [Monitoring the Creation of New Issues](#monitoring-the-creation-of-new-issues) + - [General Guidelines](#general-guidelines) + + +___ ## Issue Management In all cases please use the [GitHub open issue search](https://github.com/PalisadoesFoundation/talawa/issues) to check whether the issue has already been reported. -### Existing Issues - -1. Sometimes duplicate issues are created. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository. -1. If the issue is already reported and not assigned to anyone and you are interested in working on the issue then: - 1. Ask for the issue to be assigned to you in the issue comments - 1. Ask our contributors to assign it to you in `#talawa` slack channel. -1. We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/talawa/issues?q=is%3Aissue+is%3Aopen+label%3Ano-issue-activity) label to them. Use the issue comments to ask whether the assignee is still working on the issue, and if not, ask for the issue to be assigned to you. - ### New Issues -To create new issues: +To create new issues follow these steps: + +1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created. +1. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository. 1. Click on the [`New Issue`](https://github.com/PalisadoesFoundation/talawa/issues/new/choose) button 1. Use the templates to create a standardized report of what needs to be done and why. 1. If you want to be assigned the issue that you have created, then add a comment immediately after submitting it. +We welcome contributors who find new ways to make the code better. + +### Existing Issues + +You can also be a valuable contributor by searching for dormant issues. Here's how you can do that: + +1. **Previously Assigned Issues**: We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/talawa/issues?q=is%3Aissue+is%3Aopen+label%3Ano-issue-activity) label to them. Use the issue comments to ask whether the assignee is still working on the issue, and if not, ask for the issue to be assigned to you. +1. **Unassigned Issues**: If the issue is already reported and [not assigned to anyone](https://github.com/PalisadoesFoundation/talawa/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee) and you are interested in working on the issue then: + 1. Ask for the issue to be assigned to you in the issue comments + 2. Ask our contributors to assign it to you in `#talawa` slack channel. + +Working on these types of existing issues is a good way of getting started with the community. + ### Feature Request Issues -1. Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible. + +Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible. ### Monitoring the Creation of New Issues -1. Join our `#talawa-github` channel for automatic issue and pull request updates +1. Join our `#talawa-github` slack channel for automatic issue and pull request updates ## General Guidelines