Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions proposed_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Issue Title: Fix documentation typos and list numbering

# Issue Description:

I have identified several text formatting issues and typos in the project documentation that need to be addressed.

## Issues Identified:

1. **Duplicate Step Numbering in CONTRIBUTING.md**:
- In the "Contributing" section, there are two steps numbered "7".
- Line 76: `7. Make sure branch is synced...`
- Line 79: `7. Push to the Branch...`
- The numbering should be corrected so that "Push to the Branch" is step 8, and the following steps are incremented.

2. **Typo in CONTRIBUTING.md**:
- Line 32: `4. Get the dependancies` -> Should be `dependencies`.

3. **Typos in README.md**:
- Line 140: `You can Check community guidlines` -> "guidlines" should be "guidelines".

4. **Capitalization in README.md**:
- Line 140: `You can Check community guidlines` -> "Check" should be lowercase ("check") as it is in the middle of a sentence.

## Proposed Changes:
- Update `CONTRIBUTING.md` to fix the step numbering and spelling of "dependencies".
- Update `README.md` to fix the spelling of "guidelines" and lowercase "Check".