Skip to content

Commit

Permalink
Update feature_request.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fricoben authored Nov 14, 2024
1 parent d41593e commit a8a9a6d
Showing 1 changed file with 33 additions and 8 deletions.
41 changes: 33 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,43 @@
name: Feature request
about: Describe the feature you want and propose some steps to achieve it
title: ""
labels: ""
labels: "open for contribution"
assignees: ""
---

## Description
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Description 📹

## PROPOSED TODO
[Insert clear description here]

- [ ] Your task number 1
- [ ] Your task number 2
- [ ] Your task number 3
...
## Proposed Actions 🛠️

Here's a checklist of actions to follow for resolving this issue:

1. **Fork and Create Branch**:
Fork the repository and create a new branch using the issue number:
```bash
git checkout -b fix-[issue-number]
```

2. **Implement Changes**:
[Propose the changes you would like to see in the code]

3. **Run Tests and Commit Changes**:
Make sure your changes don't break existing functionality and commit with a clear message:
```bash
git commit -m "Fix: [Short description of the fix]"
```

## Required 📋

To keep our workflow smooth, please make sure you follow these guidelines:

- **Assignment**: Don't create a pull request if you weren't assigned to this issue.
- **Timeframe**: Complete the task within **3 business days**.
- **Closing the Issue**: In your PR description, close the issue by writing `Close #[issue_id]`.
- **Review Process**:
- Once you've submitted your PR, change the label to **"ready for review"**.
- If changes are requested, address them and then update the label back to **"ready for review"** once done.
- **Testing**: Test your PR locally before pushing, and verify that tests and build are working after pushing.

Thank you for your contribution! 🙏 Let's keep our code clean and organized! 🚀

0 comments on commit a8a9a6d

Please sign in to comment.