Skip to content

Commit

Permalink
add issues templates
Browse files Browse the repository at this point in the history
* add issues templates

* update 37825e6
  • Loading branch information
CerineBnsd authored Oct 5, 2022
1 parent 6cdb489 commit 8ed60cb
Show file tree
Hide file tree
Showing 7 changed files with 181 additions and 1 deletion.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Bug
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---

<!--
Have you read GDG Algiers' [Code of Conduct?](https://github.com/GDGAlgiers/.github/CODE_OF_CONDUCT.md) By filing an Issue, you are expected to comply with it, including treating everyone with respect.
-->


# Summary
A brief description of the issue.

# Debugging steps
## How to reproduce?
Add steps to reproduce the bug
1. First step
2. Second step
3. ...

## Expected behavior
What you expect to happen in the correct scenario.

## Current behavior
Describe what actually happens.

## Demonstration
Add anything that can help better understand what's happening. For example: Screenshots and error Logs.

### Screenshots
<!--screeshots here-->

### Logs
```
Past logs here
```

# Additional Details
Add any additional information, configuration or data that might be necessary to reproduce the issue.

Examples:

- OS: [e.g. Manjaro Linux]
- OS Version: [e.g. 18.1.0]
- Language Version: [e.g. Node 16.16]
- Package Manager Version: [e.g. npm 16]
- ...
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: GDG Algiers Community server
url: https://discord.gg/7EvsP7eemQ
about: Our discord server
- name: GDG Algiers Website
url: https://www.gdgalgiers.com/
about: Our website
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Improvement
about: Suggest an improvement to an existing functionality
title: ''
labels: ''
assignees: ''
---

<!--
Have you read GDG Algiers' [Code of Conduct?](https://github.com/GDGAlgiers/.github/CODE_OF_CONDUCT.md) By filing an Issue, you are expected to comply with it, including treating everyone with respect.
-->

# Summary
A brief description of the improvement.

# Background
## Motivation and context
Explain what make you think this enhancement is needed. Make sure to link any exisiting Issues (or Pull Requests) that are related to this one (Whether they are closed or not).

## Suggested Solution
Describe clearly the solution you'd like to have, and any other possible alternative.

## Outcome
Describe briefly what the end result will be, once this issue is solved.

# Tests Plan
Explain the tests that should be added/edited to make sure this improvement works, and doesn't affect other parts of the project.

# Additional Details
Add any additional and important details.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: New Feature
about: Suggest a new idea for this project.
title: ''
labels: ''
assignees: ''
---

<!--
Have you read GDG Algiers' [Code of Conduct?](https://github.com/GDGAlgiers/.github/CODE_OF_CONDUCT.md) By filing an Issue, you are expected to comply with it, including treating everyone with respect.
-->

# Summary
A brief description of the feature.

# Background

## Motivation and context
Explain what makes you think this new feature is needed. Make sure to link any exisiting Issues (or Pull Requests) that are related to this one (Whether they are closed or not).

## Proposed solution
Describe in details how you think the feature should be implemented.

## Outcome
Describe briefly what the end result will be, once this issue is solved.

# Tests
## Affected features
State the different existing features that will be broken/affected (if any) by this new feature.

## Tests plan
Explain the tests that should be added/edited to make sure this feature works correctly, and doesn't affect other parts of the project.

# Additional Details
Add any additional and important details.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Refactor
about: Refactor the codebase, or a part of it.
title: ''
labels: ''
assignees: ''
---

<!--
Have you read GDG Algiers' [Code of Conduct?](https://github.com/GDGAlgiers/.github/CODE_OF_CONDUCT.md) By filing an Issue, you are expected to comply with it, including treating everyone with respect.
-->


# Summary
A brief description of the issue.

# Background

## What should be refactored?
State the files/folders that will change due to this refactor.

## Why is this refactor needed?
Explain why you think this refactor is needed and how it will improve the project.

## How will be the result?
Describe the expected structure after the refactor is done.


# Additional Details
Add any additional and important details.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Testing
about: Add, improve or edit tests in the codebase.
title: ''
labels: ''
assignees: ''
---

<!--
Have you read GDG Algiers' [Code of Conduct?](https://github.com/GDGAlgiers/.github/CODE_OF_CONDUCT.md) By filing an Issue, you are expected to comply with it, including treating everyone with respect.
-->


# Summary
A brief description of the issue.

# Background

## Type of Test
Specify the types of tests that should be added(Integration, unit, ...)

## Expected Behavior
Describe how the result of executing the tests should be.

# Additional Details
Add any additional and important details.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# .github
# GDG Algiers Default Community Health Files

0 comments on commit 8ed60cb

Please sign in to comment.