Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug report
description: Report a reproducible Planer failure.
title: "[Bug]: "
labels: [bug]
body:
- type: input
id: version
attributes:
label: Planer version
placeholder: 0.1.0
validations:
required: true
- type: input
id: windows
attributes:
label: Windows version
placeholder: Windows 11 24H2 x64
validations:
required: true
- type: dropdown
id: area
attributes:
label: Affected area
options: [Project launcher, Boards, Canvas, Autosave, Export, Theme, Installer, Other]
validations:
required: true
- type: textarea
id: steps
attributes:
label: Reproduction steps
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
validations:
required: true
- type: textarea
id: sample
attributes:
label: Safe sample project or screenshots
description: Remove private project content before attaching files.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Private security report
url: https://github.com/sufyanaser/Planer/security/advisories/new
about: Report vulnerabilities privately rather than in a public issue.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Propose a focused visual-planning improvement.
title: "[Feature]: "
labels: [enhancement]
body:
- type: textarea
id: problem
attributes:
label: Planning problem
description: Describe the workflow that is difficult today.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
validations:
required: true
- type: textarea
id: data
attributes:
label: Data and compatibility impact
description: Explain effects on projects, boards, autosave, and exported formats.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## What changed

Describe the focused change and the planning workflow it improves.

## Validation

- [ ] `npm ci`
- [ ] `npm run check:version`
- [ ] `npm run lint`
- [ ] `npm run build`
- [ ] Tauri/Rust validation completed when native files changed
- [ ] Visible UI changes include screenshots
- [ ] Persistence changes include create, autosave, close, reopen, and export checks

## Data and release risk

Describe effects on IndexedDB, `.planer` or `.excalidraw` data, autosave, migration compatibility, native packaging, and the release workflow.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing

## Branch and scope

1. Branch from `develop`.
2. Keep each pull request focused on one coherent change.
3. Discuss large product or data-format changes in an issue before implementation.
4. Preserve local-first behavior, project data, autosave, and existing `.planer` exports.
5. Do not merge directly to `main`; it is the verified release source.

## Validation

Run before opening a pull request:

```bash
npm ci
npm run check:version
npm run lint
npm run build
```

When Rust or Tauri configuration changes, also run:

```bash
cargo check --manifest-path src-tauri/Cargo.toml
npm run tauri build
```

Include screenshots for visible UI changes. For persistence changes, describe the create, autosave, close, reopen, export, and recovery checks performed.

## Release boundary

Feature and fix pull requests target `develop`. A release is prepared separately, with synchronized npm, Cargo, and Tauri versions, an updated changelog, green CI, and verified Windows installers before promotion to `main`.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ V1 does not include accounts, cloud sync, team workspaces, real-time collaborati

## Contributing and security

Planer is still in foundational development. Discuss large features in an issue before implementation, keep changes focused, and report the validation commands used.
Planer is still in foundational development. Discuss large features in an issue before implementation, keep changes focused, and report the validation commands used. See [CONTRIBUTING.md](CONTRIBUTING.md) for the branch, validation, and UI evidence requirements.

Do not report security vulnerabilities in a public issue. Use [GitHub private vulnerability reporting](https://github.com/sufyanaser/Planer/security/advisories/new).

Expand Down
Loading
Loading