gavindiaz/awesome-quant
1
0
Fork 0
mirror of https://github.com/wilsonfreitas/awesome-quant.git synced 2026-08-19 14:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify guidelines for submitting multiple related projects in PRs and enhance rejection criteria for clarity

Browse Source
This commit is contained in:
Wilson Freitas
2026-03-28 10:23:42 -03:00
parent e0ac384cae
commit c20e6f26a3
2 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+14 -2
View File
@@ -61,9 +61,21 @@ Add your entry under the correct language heading (`##`) and category subheading
If no existing category fits, suggest a new one in your PR description.
## One Project Per PR
## Multiple Related Projects Per PR
Submit one project per pull request. This makes review faster and keeps the git history clean.
**Preferred:** One project per pull request for clarity and focused reviews.
**Acceptable:** Multiple closely related projects in a single PR if they share a common theme or data source. Examples:
- Multiple data sources from the same market or exchange (e.g., all NSE/BSE tools for Indian markets)
- Multiple tools from the same author with complementary functionality
- Multiple APIs/SDKs for the same service or data provider
- Related packages addressing a specific domain gap (e.g., UK company identifier validators)
When submitting multiple projects:
- Explain the relationship and rationale in the PR description
- Ensure each entry is placed in the correct section
- Avoid creating duplicate entries within the same README file
- All entries must meet quality and format requirements independently
## Before Submitting