Skip to content

Commit fe9d415

Browse files
committed
chore: declutter root by moving community docs and feature map
- Move CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md to .github/ - Move FEATURES.md to docs/ - Update all references in README.md and cursor rules Made-with: Cursor
1 parent d3d2fb2 commit fe9d415

6 files changed

Lines changed: 5 additions & 5 deletions

File tree

.cursor/rules/features-file.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ alwaysApply: false
66

77
# Feature Map Maintenance
88

9-
When adding a new user-facing feature (page, section, chart, badge, metric, setting, or API endpoint), update `FEATURES.md` to reflect the change. Keep entries short — one line per item, grouped under the correct page heading.
9+
When adding a new user-facing feature (page, section, chart, badge, metric, setting, or API endpoint), update `docs/FEATURES.md` to reflect the change. Keep entries short — one line per item, grouped under the correct page heading.
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Also supports **email alerts** via [Resend](https://resend.com) (one API key, no
131131
| **Anomalies** | Open incidents, MTTD/MTTI/MTTR metrics, full anomaly timeline |
132132
| **Settings** | Detection thresholds, expensive model alerts, billing group management, HiBob CSV import, group export/import |
133133

134-
> For a detailed breakdown of every section, metric, badge, and chart, see [FEATURES.md](FEATURES.md).
134+
> For a detailed breakdown of every section, metric, badge, and chart, see [FEATURES.md](docs/FEATURES.md).
135135
136136
---
137137

@@ -482,7 +482,7 @@ Rate limit: 20 requests/minute (Admin API), 100 requests/minute (Analytics API).
482482

483483
This project handles sensitive usage and spending data, so security matters here more than most.
484484

485-
- **Vulnerability reporting**: See [SECURITY.md](SECURITY.md) for the disclosure policy. Report vulnerabilities privately via [GitHub Security Advisories](https://github.com/ofershap/cursor-usage-tracker/security/advisories/new), not public issues.
485+
- **Vulnerability reporting**: See [SECURITY.md](.github/SECURITY.md) for the disclosure policy. Report vulnerabilities privately via [GitHub Security Advisories](https://github.com/ofershap/cursor-usage-tracker/security/advisories/new), not public issues.
486486
- **Automated scanning**: Every push and PR goes through [CodeQL](https://codeql.github.com/) (SQL injection, XSS, CSRF, etc.) and [Dependabot](https://docs.github.com/en/code-security/dependabot) for dependency vulnerabilities.
487487
- **OpenSSF Scorecard**: Continuously evaluated against [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/ofershap/cursor-usage-tracker) security benchmarks.
488488
- **OpenSSF Best Practices**: [Passing badge](https://www.bestpractices.dev/projects/11968) earned.
@@ -494,11 +494,11 @@ This project handles sensitive usage and spending data, so security matters here
494494

495495
## Contributing
496496

497-
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and guidelines. Bug reports, feature requests, docs improvements, and code are all welcome. Use [conventional commits](https://www.conventionalcommits.org/) and make sure CI is green before opening a PR.
497+
See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for setup and guidelines. Bug reports, feature requests, docs improvements, and code are all welcome. Use [conventional commits](https://www.conventionalcommits.org/) and make sure CI is green before opening a PR.
498498

499499
## Code of Conduct
500500

501-
This project uses the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
501+
This project uses the [Contributor Covenant Code of Conduct](.github/CODE_OF_CONDUCT.md).
502502

503503
## Author
504504

File renamed without changes.

0 commit comments

Comments
 (0)