Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
fricoben authored Nov 15, 2024
1 parent 025113e commit 83e3799
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/contributor-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Contributor Issue
about: Create an issue for it to be taken by a contributor
title: Name your issue
labels: Good first issue, OD Hack, open for contribution
assignees: ''

---

## Description 📹

**[Insert clear description here]**

## 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**:
[Insert Code snippet if needed with a mardown todo list]

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 🙏

⚠️ WARNING: Failure to follow the requirements above may result in being added to the OnlyDust blacklist, affecting your ability to receive future rewards.

0 comments on commit 83e3799

Please sign in to comment.