|
4 | 4 |
|
5 | 5 | 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.
|
6 | 6 |
|
| 7 | +___ |
| 8 | +## Table of Contents |
| 9 | +<!-- TOC --> |
| 10 | + |
| 11 | +- [Issue Report Guidelines](#issue-report-guidelines) |
| 12 | + - [Table of Contents](#table-of-contents) |
| 13 | + - [Issue Management](#issue-management) |
| 14 | + - [New Issues](#new-issues) |
| 15 | + - [Existing Issues](#existing-issues) |
| 16 | + - [Feature Request Issues](#feature-request-issues) |
| 17 | + - [Monitoring the Creation of New Issues](#monitoring-the-creation-of-new-issues) |
| 18 | + - [General Guidelines](#general-guidelines) |
| 19 | + |
| 20 | +<!-- /TOC --> |
| 21 | +___ |
7 | 22 | ## Issue Management
|
8 | 23 |
|
9 | 24 | In all cases please use the [GitHub open issue search](https://github.com/PalisadoesFoundation/talawa-api/issues) to check whether the issue has already been reported.
|
10 | 25 |
|
11 |
| -### Existing Issues |
12 |
| - |
13 |
| -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. |
14 |
| -1. If the issue is already reported and not assigned to anyone and you are interested in working on the issue then: |
15 |
| - 1. Ask for the issue to be assigned to you in the issue comments |
16 |
| - 1. Ask our contributors to assign it to you in `#talawa-api` slack channel. |
17 |
| -1. We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/talawa-api/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. |
18 |
| - |
19 | 26 | ### New Issues
|
20 |
| -To create new issues: |
| 27 | +To create new issues follow these steps: |
| 28 | + |
| 29 | +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. |
| 30 | +1. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository. |
21 | 31 | 1. Click on the [`New Issue`](https://github.com/PalisadoesFoundation/talawa-api/issues/new/choose) button
|
22 | 32 | 1. Use the templates to create a standardized report of what needs to be done and why.
|
23 | 33 | 1. If you want to be assigned the issue that you have created, then add a comment immediately after submitting it.
|
24 | 34 |
|
| 35 | +We welcome contributors who find new ways to make the code better. |
| 36 | + |
| 37 | +### Existing Issues |
| 38 | + |
| 39 | +You can also be a valuable contributor by searching for dormant issues. Here's how you can do that: |
| 40 | + |
| 41 | +1. **Previously Assigned Issues**: We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/talawa-api/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. |
| 42 | +1. **Unassigned Issues**: If the issue is already reported and [not assigned to anyone](https://github.com/PalisadoesFoundation/talawa-api/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee) and you are interested in working on the issue then: |
| 43 | + 1. Ask for the issue to be assigned to you in the issue comments |
| 44 | + 2. Ask our contributors to assign it to you in `#talawa` slack channel. |
| 45 | + |
| 46 | +Working on these types of existing issues is a good way of getting started with the community. |
| 47 | + |
25 | 48 | ### Feature Request Issues
|
26 |
| -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. |
| 49 | + |
| 50 | +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. |
27 | 51 |
|
28 | 52 | ### Monitoring the Creation of New Issues
|
29 |
| -1. Join our `#talawa-api-github` channel for automatic issue and pull request updates |
| 53 | +1. Join our `#talawa-github` slack channel for automatic issue and pull request updates |
30 | 54 |
|
31 | 55 | ## General Guidelines
|
32 | 56 |
|
|
0 commit comments