Add governance, contributor guidelines, and enhance workflows by backslash-ux · Pull Request #1 · backslash-ux/plane-cli

backslash-ux · 2026-03-30T14:43:45Z

Introduce public governance and contributor baseline documentation. Align package identity and enhance CI workflows for improved repository quality. Move planning notes to the workspace for better organization. Update documentation to reflect these changes.

Summary by CodeRabbit

Documentation
- Added comprehensive contributor guidelines, code of conduct, and security reporting policy.
- Added architecture documentation and release process documentation.
- Updated README with structured output documentation and project badges.
Chores
- Changed package name from @aaronshaf/plane to @backslash-ux/plane.
- Added MIT license to the repository.
- Added requirement for Bun >= 1.0.0.
- Enhanced CI workflows with stricter quality gates including file size checks.

coderabbitai · 2026-03-30T14:44:28Z

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This pull request establishes comprehensive project governance, contribution standards, and release procedures. It introduces GitHub issue templates, updates CI/CD workflows, adds extensive documentation (contributing guide, architecture, releasing, security, code of conduct), migrates package identity from @aaronshaf/plane to @backslash-ux/plane, and adds license and changelog files.

Changes

Cohort / File(s)	Summary
GitHub Issue Templates `.github/ISSUE_TEMPLATE/bug_report.md`, `.github/ISSUE_TEMPLATE/feature_request.md`, `.github/ISSUE_TEMPLATE/config.yml`	Added structured issue templates for bugs and feature requests with metadata, front-matter labels, and multi-section markdown forms. Disabled blank issue creation and added contact links for security policy and contributing guide.
GitHub Workflows `.github/workflows/ci.yml`, `.github/workflows/publish.yml`	Added new `quality` job to CI that runs format checks and file-size validation. Updated `test` job dependency chain and reorganized coverage checking. Changed publish workflow to run consolidated `check:all` command and updated npm token environment variable from `NPM_TOKEN` to `NPM_CONFIG_TOKEN`.
Project Documentation & Governance `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, `AGENTS.md`, `CHANGELOG.md`, `docs/ARCHITECTURE.md`, `docs/RELEASING.md`, `README.md`, `SKILL.md`, `LICENSE`	Comprehensive documentation suite defining contribution workflow, conduct expectations, security reporting, AI agent context, architecture layers, and release procedures. Updated README with badges, structured output docs, and project info. Added MIT license and updated SKILL metadata.
Package Configuration `package.json`, `.gitignore`	Migrated package scope from `@aaronshaf/plane` to `@backslash-ux/plane` with corresponding repository metadata updates. Added `author`, `license`, `files`, and `engines` (bun >=1.0.0) fields. Updated `check:all` script to include file-size checks. Added AI/editor customization file ignores (`.github/copilot-instructions.md`, `.github/instructions/`, `.vscode/docs/`).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 A rabbit's ode to governance

Issue templates bloom, so structured and bright,
Workflows now polished, from morning to night,
Docs map the land where our CLI takes flight,
From @aaronshaf to @backslash-ux's might—
A burrow well-organized, clean, and just right! 🌳

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add governance, contributor guidelines, and enhance workflows' directly and accurately summarizes the main changes: adding governance/COC docs, contributor guidelines, and workflow enhancements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch init

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR formalizes open-source governance and contribution docs for the Plane CLI fork, aligns package/repo identity under @backslash-ux/plane, and strengthens CI quality gates and release workflow documentation.

Changes:

Add baseline public docs (contributing, security, code of conduct, architecture, releasing, agents) and a changelog.
Update npm package metadata (scope/name, repo URLs, publish files list, Bun engine) and docs to match the fork identity.
Enhance GitHub workflows (CI quality gate split, publish workflow uses check:all, updated npm token secret name) plus issue/PR templates.

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
package.json	Renames package scope/name, adds metadata (author/license/files/keywords/engines) and strengthens `check:all` gate.
docs/RELEASING.md	Documents tag-based release flow and required secrets.
docs/ARCHITECTURE.md	Adds architectural boundaries and testing model documentation.
SKILL.md	Updates agent “skill” metadata and install command to new package name.
SECURITY.md	Adds security reporting policy and scope guidance.
README.md	Updates fork attribution, installation/upgrade commands, structured output docs, and links to new project docs.
LICENSE	Adds MIT license file for the fork.
CONTRIBUTING.md	Adds contribution workflow, gates, conventions, and PR checklist.
CODE_OF_CONDUCT.md	Adds community behavior expectations and enforcement/reporting info.
CHANGELOG.md	Introduces a changelog with initial “Unreleased” entries reflecting repo baseline.
AGENTS.md	Adds versioned baseline context for AI coding agents contributing to the repo.
.gitignore	Ignores local AI/editor customization and workspace planning note paths.
.github/workflows/publish.yml	Publishes on `v*` tags, runs `check:all`, and uses `NPM_CONFIG_TOKEN` secret.
.github/workflows/ci.yml	Adds a dedicated “Repo Quality” job and reorders dependencies for tests/coverage.
.github/pull_request_template.md	Adds structured PR template with validation/doc checklists.
.github/ISSUE_TEMPLATE/feature_request.md	Adds feature request intake template oriented around CLI workflows.
.github/ISSUE_TEMPLATE/config.yml	Disables blank issues and routes users to security/contributing links.
.github/ISSUE_TEMPLATE/bug_report.md	Adds bug report template with environment + repro sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-30T14:47:43Z

+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:


This repo is explicitly a fork of an MIT-licensed upstream project (per README). For MIT license compliance, the LICENSE file should preserve/retain the upstream copyright notice(s) in addition to the fork’s copyright line, rather than replacing them entirely.

Suggested change

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

Copyright (c) the authors of the upstream MIT-licensed project, as identified in that project's LICENSE file.

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

Copilot · 2026-03-30T14:47:43Z

+- Preserve shared machine-readable output behavior in `src/output.ts`.
+- Keep human-readable formatting in `src/format.ts`.
+- Match the existing TypeScript style in `src/`: tabs, semicolons, and small explicit payload interfaces.
+- Keep TypeScript files below the enforced 700-line limit.


check-file-size.ts currently enforces the 700-line limit only under ./src, but this guide says "Keep TypeScript files below the enforced 700-line limit" (which reads as repo-wide). Either update the wording to clarify the limit applies only to src/, or expand the size check to include other TS locations (e.g., tests/, scripts/) so the documentation matches the enforced gate.

Suggested change

- Keep TypeScript files below the enforced 700-line limit.

- Keep TypeScript files in `src/` below the enforced 700-line limit.

backslash-ux added 5 commits March 30, 2026 18:42

docs: add public governance and contributor baseline

691885d

chore: align fork package identity

c33acad

ci: harden repo quality and release workflows

e3291b1

docs: align public workflow docs with issues

9d97d20

chore: move planning notes to workspace

e0a7591

Copilot AI review requested due to automatic review settings March 30, 2026 14:43

Copilot started reviewing on behalf of backslash-ux March 30, 2026 14:44 View session

backslash-ux merged commit 6d92b59 into main Mar 30, 2026
4 of 6 checks passed

backslash-ux deleted the init branch March 30, 2026 14:46

Copilot AI reviewed Mar 30, 2026

View reviewed changes

This was referenced Mar 31, 2026

Enhance CLI with project workflows, feature flags, and documentation updates #2

Merged

Add 'create' command for modules with optional fields #3

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add governance, contributor guidelines, and enhance workflows#1

Add governance, contributor guidelines, and enhance workflows#1
backslash-ux merged 5 commits intomainfrom
init

backslash-ux commented Mar 30, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 30, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	- Keep TypeScript files below the enforced 700-line limit.
	- Keep TypeScript files in `src/` below the enforced 700-line limit.

Conversation

backslash-ux commented Mar 30, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

backslash-ux commented Mar 30, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 30, 2026 •

edited

Loading