Repo polish: MIT license, CI, and a README that shows the product#2
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR polishes the repository’s public-facing surface by adding licensing, CI, contribution/issue hygiene, and a more product-oriented README, without changing application or engine code.
Changes:
- Adds MIT licensing and updates README to reflect the project’s positioning and features with screenshots.
- Introduces a GitHub Actions CI workflow that runs lint, tests, and a production build on pushes/PRs to
main. - Adds community health files: contributing guide, issue forms, PR template, and funding config.
Reviewed changes
Copilot reviewed 9 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Rewritten README with badges, hero/screenshot gallery, clearer product narrative, and updated project/tech sections. |
| LICENSE | Adds MIT license text for open-source distribution. |
| CONTRIBUTING.md | Adds contribution guidelines emphasizing engine purity, reality-verified changes, and green tests. |
| .github/workflows/ci.yml | Adds CI workflow to lint, test (Vitest), and build on push/PR to main. |
| .github/pull_request_template.md | Adds a PR template checklist aligned with project expectations. |
| .github/ISSUE_TEMPLATE/feature_request.yml | Adds a structured feature request form aligned with the project’s “honest prediction” philosophy. |
| .github/ISSUE_TEMPLATE/config.yml | Enables blank issues and adds a “Try GradePace” contact link. |
| .github/ISSUE_TEMPLATE/bug_report.yml | Adds a structured bug report form with reproducibility prompts. |
| .github/FUNDING.yml | Adds funding configuration to enable a Sponsor button on the repository. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+106
to
+107
| node scripts/calibrate-scan.ts efforts/*.gpx # fit terrain factors across recorded runs | ||
| node scripts/prior-scan.ts efforts/*.gpx # course-signal vs factor analysis (negative result) |
Alvaro5
force-pushed
the
docs/readme-and-oss-setup
branch
from
July 19, 2026 19:10
df0e0f0 to
05a4b39
Compare
- New pure lib logistics.ts: dwell kept out of the engine (calibration models moving time; range scales moving time only, dwell added after the band) - Stop time default 3 min/station: arrivals, finish, range, splits, nutrition legs, share image and PDF all dwell-aware - Optional start time turns every ETA into a wall-clock time (chips, hero, table, PDF), wrapping past midnight - Per-station cutoffs with honest warnings: rose when the plan misses a barrier, amber when only the slow end of the range does - Shared links carry dw/st/co
…f warnings" This reverts commit 76e922a.
# Conflicts: # README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rounds out the repo's public-facing surface. No app/engine code changes; all docs, config, and assets.
What's in here
.github/workflows/ci.yml) — runs lint, the 86-test Vitest suite, and the production build on every push and PR, with a status badge in the README. All green locally.docs/screenshots/, optimized to ~590 KB total.CONTRIBUTING.md, issue forms (bug / feature), a PR template, andFUNDING.yml.Notes
public/og.pngas the repo's social preview (Settings → General → Social preview).