diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 1a0b446..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,15 +0,0 @@ -# CODEOWNERS — automatically requests reviews from the listed users when a PR -# touches matching paths. Docs: https://docs.github.com/articles/about-code-owners -# -# NOTE: this file is OPTIONAL for single-maintainer projects. If you are the -# only person with write access, GitHub cannot request a review from yourself, -# so you can safely delete this file. It becomes useful the moment the project -# has a second collaborator or you enable "require review from code owners" -# branch protection. - -# Default owner for everything in the repo: -# * @ - -# Path-specific owners (examples — uncomment and adapt): -# /docs/ @ -# /.github/ @ diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 00b4df5..5d4cedc 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,11 +4,7 @@ # Allow issues that don't fit a template (sensible default for small projects). blank_issues_enabled: true -# Redirect non-issue conversations elsewhere (uncomment and adapt if needed): -# contact_links: -# - name: Question / discussion -# url: https://github.com/danielededo/spectral/discussions -# about: Ask questions and discuss ideas here instead of opening an issue. -# - name: Security report -# url: https://github.com/danielededo/spectral/security/policy -# about: Please report security issues privately — see SECURITY.md. +contact_links: + - name: Security report + url: https://github.com/danielededo/spectral/security/policy + about: Please report security issues privately, see SECURITY.md. diff --git a/README.md b/README.md index 83b6c52..a890018 100644 --- a/README.md +++ b/README.md @@ -168,8 +168,7 @@ tests; see [AGENTS.md](AGENTS.md) for the architecture and conventions, and │ ├── pager.ts # page strip: tabs, arrow keys, swipe │ └── style.css ├── docs/ -│ ├── README-TEMPLATE.md # README skeleton -│ ├── REPO-SETTINGS.md # GitHub settings checklist +│ ├── STORE-LISTING.md # store texts, permission justifications, images, release steps │ ├── BRANCHING-STRATEGY.md # trunk-based/GitHub Flow vs release-based │ ├── COMMIT-CONVENTION.md # Conventional Commits, with examples │ ├── AI-AGENTS.md # guidelines for CLAUDE.md / AGENTS.md @@ -179,7 +178,6 @@ tests; see [AGENTS.md](AGENTS.md) for the architecture and conventions, and │ ├── 0001-trunk-based-development.md │ └── 0002-client-only-extension.md └── .github/ - ├── CODEOWNERS ├── PULL_REQUEST_TEMPLATE.md ├── ISSUE_TEMPLATE/ │ ├── bug_report.md diff --git a/SECURITY.md b/SECURITY.md index 4449957..eb72b6d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,19 +1,15 @@ # Security Policy -This project is maintained by a solo developer (or a small team). Security reports -are taken seriously, but please keep in mind that response times are best-effort, -not backed by a dedicated security team. +Spectral is maintained by a solo developer. Security reports are taken +seriously, but response times are best-effort, not backed by a dedicated +security team. ## Reporting a vulnerability **Please do not open a public issue for security problems.** -Instead, use one of these private channels: - -1. **GitHub private vulnerability reporting** (preferred, if enabled for this - repository): go to the **Security** tab and click **Report a vulnerability**. -2. **Email**: send a report to `` with a subject line - starting with `[SECURITY]`. +Instead, use GitHub private vulnerability reporting: go to the **Security** +tab of this repository and click **Report a vulnerability**. A useful report includes: @@ -36,15 +32,8 @@ publicly. Coordinated disclosure protects users of the project. ## Supported versions -Unless stated otherwise below, only the **latest release** (and the `main` -branch) receive security fixes. - -| Version | Supported | -| ------- | --------- | -| latest | yes | -| older | no | - -[TO BE FILLED IN: adjust this table if the project maintains multiple release lines] +Only the **latest release** (and the `main` branch) receive security fixes. +Store versions are updated to the latest release. ## Scope notes diff --git a/docs/README-TEMPLATE.md b/docs/README-TEMPLATE.md deleted file mode 100644 index f4ab13d..0000000 --- a/docs/README-TEMPLATE.md +++ /dev/null @@ -1,63 +0,0 @@ -# README template for new projects - -Copy everything below the line into the new project's `README.md`, replace the -placeholders, and delete the sections that don't apply. Keep the README honest -and short: it should answer "what is this, can I use it, how do I run it" in -under a minute of reading. - ---- - -# - -[One or two sentences: what the project does and who it is for. Write this -first and keep it brutally clear; it's the most-read text in the repo.] - - - -## Features - -- [TO BE FILLED IN: the three to five things that matter, not an exhaustive list] - -## Installation - -``` -[TO BE FILLED IN: the exact commands to install or set up, copy-pasteable] -``` - -Requirements: [TO BE FILLED IN: runtime, minimum versions, OS constraints, or delete] - -## Usage - -``` -[TO BE FILLED IN: the smallest example that does something real] -``` - -[Link to further docs if they exist: `docs/`, a wiki, a site.] - -## Configuration - -[TO BE FILLED IN: environment variables, config files, defaults, or delete -this section if there is nothing to configure.] - -## Development - -``` -[TO BE FILLED IN: how to build, test, and lint locally] -``` - -See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution workflow and -[docs/COMMIT-CONVENTION.md](docs/COMMIT-CONVENTION.md) for commit messages. - -## Status / Roadmap - -[Optional: is this stable, experimental, maintained, done? Users appreciate -knowing. Delete if the version badge and changelog already say it.] - -## License - -[TO BE FILLED IN: e.g. "Distributed under the MIT License; see -[LICENSE](LICENSE)." For private repos: "Proprietary, all rights reserved."] diff --git a/docs/REPO-SETTINGS.md b/docs/REPO-SETTINGS.md deleted file mode 100644 index 1a5bcc6..0000000 --- a/docs/REPO-SETTINGS.md +++ /dev/null @@ -1,62 +0,0 @@ -# Repository Settings Checklist - -Files can't carry GitHub *settings*, so every repository created from this -template needs a few clicks of manual configuration. This checklist keeps that -step from being forgotten. It targets personal projects (solo maintainer or -small team); items are ordered by importance, and the optional ones say so. - -## One-time: on the template repository itself - -- [ ] **Settings > General > Template repository: enable.** Without this flag - the **"Use this template"** button the README relies on does not exist. - -## For every new repository created from the template - -### General (Settings > General) - -- [ ] **Default branch** is `main` (GitHub default; verify if the repo was - imported). -- [ ] **Pull requests**: allow **squash merging only** (disable merge commits - and rebase merging). One squash commit per PR keeps history readable and, - done from the web UI, the squash commit is signed by GitHub (Verified). - - Set "Default commit message" to **"Pull request title and description"** - so the squash message follows the commit convention. -- [ ] **Automatically delete head branches**: enable. Merged topic branches - have no further purpose. - -### Branch protection (Settings > Branches or Rulesets) - -Even solo, a minimal ruleset on `main` prevents accidents: - -- [ ] Require a pull request before merging (approvals can stay at 0 for a - solo maintainer; the point is blocking direct pushes, not self-review - theater). -- [ ] Block force pushes and deletions. -- [ ] Require status checks to pass, once the project has CI. [TO BE FILLED IN: - check names] -- [ ] Optional: **require signed commits**, only if you have GPG/SSH signing - configured everywhere you commit from (including remote/CI environments), - otherwise it will block your own workflow. - -### Security (Settings > Advanced Security / Code security) - -- [ ] **Dependabot alerts** and **security updates**: enable. -- [ ] **Private vulnerability reporting**: enable; `SECURITY.md` points - reporters to it as the preferred channel. -- [ ] **Secret scanning** and **push protection**: enable (free for public - repos). - -### Features (Settings > General > Features) - -- [ ] Disable what the project doesn't use (Wiki, Projects, Discussions) to - reduce surface and confusion. Enable **Discussions** only if you want - Q&A separated from issues (then link it in - `.github/ISSUE_TEMPLATE/config.yml`). - -### Optional / public projects - -- [ ] **Social preview image** (Settings > General) for nicer link sharing. -- [ ] **Topics and description** on the repo home; it helps discovery. -- [ ] **Sponsor button** via `.github/FUNDING.yml`, if you want one. -- [ ] Actions permissions (Settings > Actions): restrict to actions you trust, - and set workflow permissions to **read-only by default**. diff --git a/docs/STORE-LISTING.md b/docs/STORE-LISTING.md index 1f99512..0d3e0ff 100644 --- a/docs/STORE-LISTING.md +++ b/docs/STORE-LISTING.md @@ -69,7 +69,7 @@ git. **Privacy policy URL:** https://spectral.danielededo.it/privacy -**Website / support URL:** https://github.com/danielededo/spectral (the repository must be public for this to work; until then use the policy page) +**Website / support URL:** https://github.com/danielededo/spectral (issues for support) ## Single purpose