Wilson Freitas
5a6f90cc85
- Add site/generate.py: static site with search, filtering, sorting, dark mode - Add site/static/style.css and main.js for the new frontend - Extend parse.py: fetch CRAN published dates, PyPI release dates, and discover GitHub repos from CRAN pages as fallback data sources - Migrate from Poetry to uv (pyproject.toml + uv.lock) - Update CI workflow to use uv and generate.py pipeline - Add CONTRIBUTING.md with entry format guidelines - Add "Submit a Project" button to site nav - Update review-pr skill with all accepted entry formats - Update CLAUDE.md to reflect new architecture - Remove Quarto files (_quarto.yml, *.qmd, sync-site skill, poetry.lock) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
3.0 KiB
Contributing
Your contributions are always welcome! Please ensure your pull request meets the following guidelines.
Entry Format
Each entry must follow one of these formats:
GitHub project
- [Project Name](https://github.com/owner/repo) - Short description ending with a period.
Project with website and GitHub repo
For projects that have a dedicated website, link to the site and append the GitHub repo in the description:
- [Project Name](https://project-site.com) - Short description ending with a period. [GitHub](https://github.com/owner/repo)
CRAN project
Link to the CRAN package page. If the project has a GitHub repo, append it after the description:
- [Package Name](https://cran.r-project.org/package=pkgname) - Short description ending with a period.
- [Package Name](https://cran.r-project.org/package=pkgname) - Short description ending with a period. [GitHub](https://github.com/owner/repo)
PyPI project
Link to the PyPI package page. If the project has a GitHub repo, append it after the description:
- [package-name](https://pypi.org/project/package-name/) - Short description ending with a period.
- [package-name](https://pypi.org/project/package-name/) - Short description ending with a period. [GitHub](https://github.com/owner/repo)
General rules
- Use
https://URLs only. - GitHub repository URLs are strongly preferred. Projects with GitHub repos get automated tracking of stars, activity, and archive status on awesome-quant.com.
- The description must end with a period (before the
[GitHub]link, if present). - Keep descriptions concise — one sentence.
Quality Requirements
- Active: Project must show recent activity (commits within the last 12 months).
- Documented: Clear README with usage examples.
Commercial & Proprietary Projects
Commercial and proprietary projects are welcome. They will be placed under the Commercial & Proprietary Services section. Include a link to the product website and a brief description of what it offers.
Section Placement
Add your entry under the correct language heading (##) and category subheading (###). If the project is a Python backtesting library, it goes under ## Python → ### Trading & Backtesting, not under ### Indicators.
If no existing category fits, suggest a new one in your PR description.
One Project Per PR
Submit one project per pull request. This makes review faster and keeps the git history clean.
Before Submitting
- Search the existing list to make sure the project is not already included.
- Search previous Pull Requests (open and closed) to avoid duplicates.
- Make sure the entry format matches exactly — our parser relies on it.
Automatic Rejection
PRs will be closed if:
- Multiple projects added in a single PR.
- Entry format does not match the required pattern.
- Duplicate of an existing entry or a recently closed PR.
- Project is archived or abandoned.
- Empty PR description.