HannahTalksDev / HannahTalksDev/MedicineSymptomLookup
GROUP 4 -Add example to Contributers.md file so people know how to contribute
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Add assignee instructions to CONTRIBUTING.md
**Problem:**
Multiple people might work on the same issue at once, causing duplicate work and confusion.
**Task:**
Add instructions about assigning yourself to issues before starting work.
**File Location:**
Navigate to `CONTRIBUTING.md`
**Instructions:**
1. Open `CONTRIBUTING.md`
2. Find the section "Making a Contribution" (around line 12)
3. Add a new subsection before the existing steps:
```markdown
### Before You Start
**Assign yourself to the issue** - Check if someone is already assigned. If the issue is unassigned, assign yourself before starting work.
### Steps
```
4. The existing numbered list should remain under the "Steps" header
**Result should look like:**
```markdown
## Making a Contribution
### Before You Start
**Assign yourself to the issue** - Check if someone is already assigned. If the issue is unassigned, assign yourself before starting work.
### Steps
1. Create a new branch: `git checkout -b issue-number/your-feature-name`
2. Make your changes...
```
---
**Submission Instructions:**
1. **First, assign yourself to this issue (#4)** on GitHub
2. Checkout a new branch: `git checkout -b #4/branch-name`
3. Make the changes described above
4. Stage changes: `git add .`
5. Commit: `git commit -m "add message"`
6. Push branch: `git push origin #4/add-assignee-instructions`
7. Create a pull request against `main` on GitHub (remember to select your own branch)
**Notes:**
- Branch name format: `#4/descriptive-name` to link with this issue
- Can use VS Code's Git tools as an alternative to CLI
- Pull request description will be added as homework
- **Practice what you're documenting - assign yourself to this issue first!**
Contributor guide
Assessment
This issue has not been assessed yet.