Skip to content

docs: fix typos and grammar in QF documentation #2320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HusseinAdeiza wants to merge 1 commit into
base: staging
Choose a base branch
from
Open

docs: fix typos and grammar in QF documentation #2320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/qfRoundInstruction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
<img width="1907" alt="Screen Shot 1402-04-20 at 11 58 44" src="https://github.com/Giveth/impact-graph/assets/9850545/7ac55e3d-7a17-4f44-9823-bcca3a9b4316">

* **Name** name of round that we show in the UI
* **Is Active** If we want qfRound be active we should check this option. **Be careful we can just have one active qfRound, otherwise system would not work well in this state**
* **Is Active** If we want qfRound to be active we should check this option. **Be careful we can only have one active qfRound, otherwise system would not work well in this state**
* **Allocated Fund** The amount of fund that we want to distribute in this round ( USD value)
* **Minimum Passport Score** At the end of the round we just consider donations whose donor passport score is greater than or equal to this field
* **Begin Date** Exact time of when we want to begin round
* **End Date** Exact time of when round supposed to end **be careful of this field, because when end date passes admins can not edit round anymore**
* **End Date** Exact time of when the round is supposed to end **be careful of this field, because when the end date passes, admins cannot edit the round anymore**


# List
Expand All @@ -18,13 +18,13 @@ Admins can see list of QF Rounds here
# Show Single QF Round
<img width="1733" alt="Screen Shot 1402-04-20 at 12 10 16" src="https://github.com/Giveth/impact-graph/assets/9850545/239f9fe9-4684-4789-b2c6-11ad62f0a6a2">

You can see qf round detail and related projects of a qf round in this page
You can see QF round details and related projects of a qf round in this page
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix capitalization inconsistency within the same sentence.

The sentence uses both "QF round" and "qf round" inconsistently. Choose one capitalization style and apply it throughout.

📝 Proposed fix for consistency 
-You can see QF round details and related projects of a qf round in this page
+You can see QF round details and related projects in this page

Or, if you want to be more explicit:

-You can see QF round details and related projects of a qf round in this page
+You can see QF Round details and related projects of a QF Round in this page

Additionally, consider "on this page" instead of "in this page" for better English.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can see QF round details and related projects of a qf round in this page
You can see QF round details and related projects in this page
Suggested change
You can see QF round details and related projects of a qf round in this page
You can see QF Round details and related projects of a QF Round in this page
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/qfRoundInstruction.md` at line 21, The sentence "You can see QF round
details and related projects of a qf round in this page" has inconsistent
capitalization and a preposition issue; update it to use a single consistent
form (e.g., "QF round" everywhere) and change "in this page" to "on this page"
so it reads: "You can see QF round details and related projects of a QF round on
this page" (or choose the alternate preferred casing and apply it to both
occurrences of "QF round"/"qf round").


# Add projects to an active QF round
## Project list
<img width="1565" alt="Screen Shot 1402-04-20 at 12 38 11" src="https://github.com/Giveth/impact-graph/assets/9850545/e9e6f54a-21a5-471a-a662-e94ad4067cbf">

You can select multiple project and add/remove them to existing active QF Round with these two buttons
You can select multiple projects and add/remove them to existing active QF Round with these two buttons
**Add To Qf Round** and **Remove From Qf Round**

## Project page
Expand Down
4 changes: 2 additions & 2 deletions docs/qfRoundMatchingFundCalculation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# how our Actual matching fund is calculated

## Formula
We use Gitcoin formula you can see the detail https://qf.gitcoin.co/?grant=1,2,3&grant=4,5,6&grant=12,1&grant=8&match=1000
We use Gitcoin formula you can see the details https://qf.gitcoin.co/?grant=1,2,3&grant=4,5,6&grant=12,1&grant=8&match=1000
and play it with different amounts to see what happens

## Edge Cases
Expand Down Expand Up @@ -31,7 +31,7 @@ whether they have donations or not. If they have no donations, the amount will b
* Ensures pending and failed donation statuses are **excluded** from both pre-analysis and post-analysis totals

## Estimated Matching
Estimated Matching is like actual matching except we **dont ignore** donations in these cases :
Estimated Matching is like actual matching except we **don't ignore** donations in these cases :
* donations from recipients of verified projects
* donations from users with low passport scores
* donations from sybil users
Expand Down