Skip to content

Commit 8c9fd6e

Browse files
committed
Showcase StarBound with a recorded demo and clear contributor documentation
1 parent 64e976e commit 8c9fd6e

11 files changed

Lines changed: 255 additions & 145 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Report a bug
2+
description: A control, calculation, export or rendering behavior is not working.
3+
title: '[Bug]: '
4+
body:
5+
- type: textarea
6+
id: behavior
7+
attributes:
8+
label: What happened?
9+
description: Include the tab, action, expected behavior and actual result.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: reproduction
14+
attributes:
15+
label: How can we reproduce it?
16+
description: List the steps. Attach an exported scenario JSON when the issue involves a result.
17+
validations:
18+
required: true
19+
- type: input
20+
id: environment
21+
attributes:
22+
label: Environment
23+
placeholder: Browser, operating system, public demo or local commit
24+
- type: textarea
25+
id: evidence
26+
attributes:
27+
label: Supporting evidence
28+
description: Screenshots or error messages are useful. Do not include local lab tokens or credentials.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Explore the live simulator
4+
url: https://starbound.vnmoorthy.chatgpt.site
5+
about: Try the controls and export a scenario before reporting a numerical issue.
6+
- name: Read the model and its boundaries
7+
url: https://github.com/vnmoorthy/starbound/blob/main/docs/PHYSICS.md
8+
about: Separate an assumption change from an implementation error.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Suggest a scientific correction
2+
description: Challenge an equation, assumption, unit, system boundary or interpretation.
3+
title: '[Science]: '
4+
body:
5+
- type: dropdown
6+
id: category
7+
attributes:
8+
label: What needs attention?
9+
options:
10+
- Equation or implementation
11+
- Scenario assumption
12+
- Missing physical process
13+
- Documentation or interpretation
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: current
18+
attributes:
19+
label: Current claim or behavior
20+
description: Link the equation, source line or documentation passage and include units.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: proposed
25+
attributes:
26+
label: Proposed correction and evidence
27+
description: State the system boundary and cite a primary source or provide a reproducible derivation.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: validation
32+
attributes:
33+
label: How should we validate it?
34+
description: A reference result, limiting case or independent calculation is particularly useful.

‎.github/pull_request_template.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Change
2+
3+
Describe the problem and resulting behavior.
4+
5+
## Evidence
6+
7+
For numerical changes, include the units, system boundary, source or derivation, and a reference result. Identify whether this corrects an equation or changes a scenario assumption.
8+
9+
## Validation
10+
11+
List the relevant checks you ran and any remaining limitation. Ordinary changes should not require model inference.

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,6 @@ next-env.d.ts
4646
# Presentation finalizer temporary workbook snapshots
4747
/.chart-data-*/
4848
.gstack/
49+
50+
# Microsoft Office lock files
51+
~$*

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Useful contributions include independently sourced corrections, reproducible mod
44

55
Before proposing a scientific change, state the system boundary, units, source, current behavior and expected behavior. Distinguish changing a scenario assumption from correcting an equation. Preserve the host-side grader and publish all benchmark attempts when changing an evaluation protocol.
66

7-
Run `npm run typecheck`, `npm test` and `npm run build`. Keep runtime logs, model credentials, local lab tokens and private reasoning out of commits. No model call is required for ordinary CI.
7+
Run `npm run typecheck`, `npm run lint`, `npm test` and `npm run build`. Keep runtime logs, model credentials, local lab tokens and private reasoning out of commits. No model call is required for ordinary CI.
88

9-
The numerical model is illustrative. Do not present a new default value as a measured Mercury capability without an appropriate source and validation. UI result numbers must come from the engine.
9+
The numerical model is illustrative. Do not present a new default value as a measured Mercury capability without an appropriate source and validation. Physical UI metrics must come from the monthly engine or the explicitly separated engineering calculators. Concept imagery and illustrative motion must remain labeled.
10+
11+
Start with the [documentation index](docs/README.md). Use the scientific-correction issue form for equations, assumptions and system boundaries; use the bug form for reproducible software failures.

0 commit comments

Comments
 (0)