Add the donor list, a security policy & configuration for issue templates#4
Add the donor list, a security policy & configuration for issue templates#4AR-DEV-1 wants to merge 2 commits intoRedot-Engine:masterfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds three repository files: a GitHub issue template config that enables blank issues and adds contact links, a DONORS.md with donation and donor information, and a SECURITY.md describing vulnerability reporting and evidence requests. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
DONORS.md (1)
5-5: Consider shortening wording for readability.Line 5 (“any and all”) is a bit wordy; a tighter phrase reads cleaner.
Suggested wording tweak
-Our Team greatly appreciates any and all donations. +Our team greatly appreciates all donations.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@DONORS.md` at line 5, The sentence "Our Team greatly appreciates any and all donations." is wordy; update the text (the line containing that exact string) to a tighter phrasing such as "Our team greatly appreciates all donations." or "Our team greatly appreciates any donation." and ensure capitalization is consistent ("team" lowercase) with project style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@DONORS.md`:
- Around line 12-24: The donor names block is currently treated as a Markdown
code block due to four-space indentation; remove the leading four spaces from
the lines listing "Grom", "LionBox", "Mike K", etc., or convert them into a
proper Markdown list (prefix each entry with "-" or "*") so the entries render
as a readable list instead of a code block.
---
Nitpick comments:
In `@DONORS.md`:
- Line 5: The sentence "Our Team greatly appreciates any and all donations." is
wordy; update the text (the line containing that exact string) to a tighter
phrasing such as "Our team greatly appreciates all donations." or "Our team
greatly appreciates any donation." and ensure capitalization is consistent
("team" lowercase) with project style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 55ad831d-1e75-4beb-a55b-961d526f9e2d
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/config.ymlDONORS.md
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
DONORS.md (1)
5-5: Optional: Consider simplifying "any and all".The phrase "any and all donations" could be shortened to just "all donations" or "any donations" for conciseness, though the current phrasing emphasizes appreciation effectively.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@DONORS.md` at line 5, Replace the phrase "Our Team greatly appreciates any and all donations." with a more concise alternative by editing the DONORS.md line containing that exact sentence—e.g., change it to "Our team greatly appreciates all donations." (also normalize capitalization of "Team" to "team" if desired).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SECURITY.md`:
- Line 7: In the SECURITY.md sentence that reads "To report a security
vulnerability that you found in Draconic, email us at `redotengine@gmail.com`.
Please provide a video (if possible) alonside a PoC (Proof of Concept).", fix
the typo by replacing "alonside" with "alongside" so the sentence reads
"...Please provide a video (if possible) alongside a PoC (Proof of Concept)."
- Around line 3-6: Remove the placeholder template text in SECURITY.md that
begins "Use this section to tell people how to report a vulnerability..." (the
generic instructional lines 3-6) and replace it with actual security disclosure
content or a concise reporting guideline; specifically delete the placeholder
sentences and add a short policy describing where to report vulnerabilities,
expected response times, and next steps (or leave the section blank if you
intend to add a full policy later).
---
Nitpick comments:
In `@DONORS.md`:
- Line 5: Replace the phrase "Our Team greatly appreciates any and all
donations." with a more concise alternative by editing the DONORS.md line
containing that exact sentence—e.g., change it to "Our team greatly appreciates
all donations." (also normalize capitalization of "Team" to "team" if desired).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7a6feb07-7831-431d-84b4-57f1a9c9b380
📒 Files selected for processing (3)
.github/ISSUE_TEMPLATE/config.ymlDONORS.mdSECURITY.md
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/ISSUE_TEMPLATE/config.yml
0e50109 to
6800ede
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SECURITY.md`:
- Around line 1-4: The file contains duplicated headings ("# Security Policy"
and "## Reporting a Vulnerability"); remove the repeated second occurrence so
each heading appears only once and the document has a single "# Security Policy"
followed by a single "## Reporting a Vulnerability" heading to fix the MD024
static analysis warning.
| contact_links: | ||
| - name: Draconic proposals | ||
| url: https://github.com/Redot-Engine/draconic-proposals | ||
| about: Please submit feature proposals on the Draconic proposals repository, not here. | ||
|
|
||
| - name: Draconic documentation repository | ||
| url: https://github.com/Redot-Engine/draconic-docs | ||
| about: Please report issues with documentation on the Draconic documentation repository, not here. | ||
|
|
||
| - name: Draconic community channels | ||
| url: https://draconicengine.org/community | ||
| about: Please ask for technical support on one of the other community channels, not here. |
There was a problem hiding this comment.
None of these repos or links exist.
@OldDev78 @mcdubhghlas @tindrew thoughts?
There was a problem hiding this comment.
It might be better if such things are set up before a url for them exists in the source tree.
There was a problem hiding this comment.
@Arctis-Fireblight Let's set them up or leave this PR for later then
There was a problem hiding this comment.
🧹 Nitpick comments (1)
DONORS.md (1)
5-5: Optional wording polish for readability.You could tighten this sentence slightly: “Our team greatly appreciates all donations.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@DONORS.md` at line 5, Replace the sentence "Our Team greatly appreciates any and all donations." with the tightened wording "Our team greatly appreciates all donations." — change the capitalization of "Team" to "team" and remove "any and" to improve readability in DONORS.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@DONORS.md`:
- Line 5: Replace the sentence "Our Team greatly appreciates any and all
donations." with the tightened wording "Our team greatly appreciates all
donations." — change the capitalization of "Team" to "team" and remove "any and"
to improve readability in DONORS.md.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ff058825-dced-4e4c-a38f-3e4e2a6e65a9
📒 Files selected for processing (3)
.github/ISSUE_TEMPLATE/config.ymlDONORS.mdSECURITY.md
✅ Files skipped from review due to trivial changes (2)
- SECURITY.md
- .github/ISSUE_TEMPLATE/config.yml
TL;DR
Note
For now, the config has blank issues set to true until we make issue templates
Note
Contributed by 2LazyDevs.
Summary by CodeRabbit