From b3558fcc6b0c72e80a25b23d6bd02abeaba78efb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=AAsufian=20nasser=E2=80=AC=E2=80=8F?= <166199800+sufyanaser@users.noreply.github.com> Date: Sat, 8 Aug 2026 06:01:15 +0300 Subject: [PATCH] chore(repo): prepare Planer 0.1.0 release Version: 0.1.0 - Added manual CI dispatch and concurrency protection - Added Planer security and conduct policies - Expanded the README with product highlights and release status - Verified npm ci, lint, production build, and workflow YAML --- .github/workflows/ci.yml | 5 +++++ CHANGELOG.md | 1 + CODE_OF_CONDUCT.md | 17 +++++++++++++++++ README.md | 18 +++++++++++++++++- SECURITY.md | 25 +++++++++++++++++++++++++ 5 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 26906df..1c76b71 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,6 +1,7 @@ name: Planer CI on: + workflow_dispatch: push: branches: [develop, main] pull_request: @@ -9,6 +10,10 @@ on: permissions: contents: read +concurrency: + group: planer-ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + jobs: quality: runs-on: ubuntu-latest diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e31d48..b043e9f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ All notable changes to Planer are documented here. - Light and dark appearance support. - `.planer` and `.excalidraw` JSON exports. - Windows CI workflow for lint, web build, and Tauri installer artifacts. +- Manual CI dispatch, concurrency protection, and repository governance documents. ### Removed diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c01deda --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,17 @@ +# Code of Conduct + +## Our standard + +Planer welcomes constructive participation. Contributors are expected to communicate professionally, critique ideas rather than people, respect differing experience and viewpoints, and keep technical discussions focused on improving the project. + +Unacceptable behavior includes harassment, discrimination, threats, deliberate disruption, publication of private information, or sustained personal attacks. + +## Scope + +This policy applies to repository issues, pull requests, reviews, discussions, and other spaces where a participant represents the Planer project. + +## Enforcement + +Report conduct concerns privately to the repository owner through their GitHub profile. Reports will be reviewed in confidence. Project maintainers may edit or remove content, reject contributions, restrict participation, or ban participants when behavior conflicts with this policy. + +Enforcement decisions will consider context, severity, recurrence, and impact on the community and project. diff --git a/README.md b/README.md index 025b595..0cff1ba 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # Planer -Planer is a fast, local-first visual planning workspace for Windows. It combines a focused desktop shell with the Excalidraw canvas engine and a project model that supports multiple boards. +Planer is a fast, local-first visual planning workspace for Windows. Open, draw, connect, organize, explain, and export without an account or cloud dependency. + +> **Status:** `0.1.0` baseline. Active development happens on `develop`; stable desktop releases are promoted to `main` after verification. + +## Highlights + +- Infinite canvas powered by the Excalidraw engine. +- Multiple boards inside one visual-planning project. +- Local IndexedDB persistence with automatic saving. +- `.planer` and `.excalidraw` exports. +- Light and dark appearance modes. +- Native Windows packaging through Tauri v2. ## Stack @@ -42,3 +53,8 @@ See [`docs/PLANER_PRODUCT_BLUEPRINT_V1.md`](docs/PLANER_PRODUCT_BLUEPRINT_V1.md) ## License Planer licensing is pending a project-owner decision. Legacy draw.io licensing and citation files were removed with the legacy scaffold. + +## Security and conduct + +- Report vulnerabilities privately using [GitHub Security Advisories](../../security/advisories/new). +- Participation is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..745bd3f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,25 @@ +# Security Policy + +## Supported versions + +Planer is currently in its initial development phase. Security fixes are applied to the latest published version only. + +| Version | Supported | +| --- | --- | +| 0.1.x | Yes | +| Earlier versions | No | + +## Reporting a vulnerability + +Please do not disclose suspected vulnerabilities in public issues or discussions. + +Use the repository's **Security** tab to open a private vulnerability report through GitHub Security Advisories. Include: + +- the affected Planer version; +- operating system and architecture; +- clear reproduction steps; +- the expected and observed behavior; +- impact and any suggested mitigation; +- supporting logs, screenshots, or proof of concept where appropriate. + +The maintainer will acknowledge a complete report as soon as practical, assess its impact, and coordinate remediation and disclosure. Do not access data that is not yours, degrade services, or perform destructive testing while investigating.