docs: add contributor, security, and forge templates

Add CONTRIBUTING/SECURITY/CHANGELOG, Gitea issue and PR templates, and README guidance for Gitea metadata and releases.

Made-with: Cursor
This commit is contained in:
2026-04-16 22:14:45 -06:00
parent 725a72a773
commit 10f6ae1c2b
7 changed files with 195 additions and 0 deletions

View File

@@ -2,6 +2,8 @@
Deterministic **C** numerical core (FDM + FEA), **Node** API for XML and orchestration, **TypeScript** GUI for workflow. See **[AGENTS.md](AGENTS.md)** for agent rules and **[Agents/MATH_SPEC.md](Agents/MATH_SPEC.md)** for equations and paper citations.
Contributor workflow: **[CONTRIBUTING.md](CONTRIBUTING.md)** · Security: **[SECURITY.md](SECURITY.md)** · History: **[CHANGELOG.md](CHANGELOG.md)**
## Repository layout
| Directory | Purpose |
@@ -24,6 +26,31 @@ Build a transparent, deterministic rod-string and wellbore mechanics platform th
- Inspectability of imported case data and solver assumptions.
- Multi-model validation (FDM vs FEA) with clear comparison metadata.
## Forge metadata (Gitea)
Repository **title**, **description**, **topics**, default branch protections, and **Releases** are configured in the Gitea UI (they are not stored as files in git).
Suggested values you can paste into the repo settings page for [connermajic/rods](https://gitea.majicmedia.ca/connermajic/rods.git):
- **Name / title:** `Rods` (or `Rods — rod-string solver stack`)
- **Description:** `Deterministic C core (FDM+FEA) + Node XML/SI API + TypeScript GUI for sucker-rod dynamometer workflows.`
- **Topics / keywords:** `sucker-rod`, `dynamometer`, `rod-pumping`, `finite-difference`, `finite-element`, `wellbore-trajectory`, `oil-and-gas`, `typescript`, `nodejs`, `c`
- **Website:** leave blank until you publish a demo URL
### Releases
Releases are optional until you want a downloadable snapshot. When you are ready:
1. Pick a version (for example `v0.1.0`).
2. Tag the commit on `main`:
```bash
git tag -a v0.1.0 -m "v0.1.0 — initial published snapshot"
git push origin v0.1.0
```
3. In Gitea: **Releases → New Release**, select the tag, paste notes from `CHANGELOG.md`, and attach artifacts if you build any.
## Prerequisites
- **Local:** `gcc`, `make`, Node 20+, `npm`