Skip to content

[codex] Add repository workflow documentation#1

Merged
nickmoreton merged 6 commits into
mainfrom
chore/repo-workflow-docs
Mar 29, 2026
Merged

[codex] Add repository workflow documentation#1
nickmoreton merged 6 commits into
mainfrom
chore/repo-workflow-docs

Conversation

@nickmoreton

Copy link
Copy Markdown
Contributor

Summary

Goal

Document the repository workflow expectations for contributors and AI agents, add a shared pull request template, and align package metadata with the repository license.

Approach

Add contributor-facing workflow documentation in the repository root and docs/, update the in-repo agent guidance to match, add the GitHub pull request template used for future PRs, and set the project license metadata to MIT to match the new LICENSE file.

Affected Areas

  • Repository workflow and contributor policy documentation
  • Agent workflow guidance in AGENTS.md
  • Pull request template under .github/
  • Package metadata in package.json and pyproject.toml

Verification

  • npm run format-check
  • npm run test
  • uv run python manage.py test

Documentation

  • Added CONTRIBUTING.md
  • Added docs/developer-onboarding.md
  • Added .github/pull_request_template.md
  • Updated README.md
  • Updated AGENTS.md

Changelog

  • Added an Unreleased entry in CHANGELOG.md covering the new repository workflow and agent publication policy.

Risks And Follow-Up

  • This change documents and standardizes workflow expectations, but any GitHub repository settings that do not yet match the written policy still need to be kept in sync separately.

Screenshots

  • N/A

@nickmoreton nickmoreton marked this pull request as ready for review March 28, 2026 17:47
@nickmoreton nickmoreton requested a review from Copilot March 28, 2026 17:48
@nickmoreton nickmoreton self-assigned this Mar 28, 2026
@nickmoreton nickmoreton added the documentation Improvements or additions to documentation label Mar 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR documents contributor and agent workflows for the repository, adds standardized PR documentation, and aligns license metadata with the repository’s MIT license.

Changes:

  • Added contributor-facing workflow docs (CONTRIBUTING.md, docs/developer-onboarding.md) and updated README.md/AGENTS.md to reference them.
  • Added a shared GitHub pull request template under .github/.
  • Added an MIT LICENSE file and updated package metadata to reflect MIT licensing.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
pyproject.toml Adds license metadata for the Python project.
package.json Updates npm package license field to MIT.
docs/developer-onboarding.md New onboarding/workflow guide for developers.
README.md Adds links and expectations for repo developer docs and PR structure.
LICENSE Adds MIT license text.
CONTRIBUTING.md New contributor workflow, checks, and agent publication gate policy.
CHANGELOG.md Adds an Unreleased entry documenting the new workflow/policy.
AGENTS.md Updates agent guidance to align with contributor workflow + PR template usage.
.github/pull_request_template.md Adds a standardized PR template for future pull requests.

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

Comment thread pyproject.toml
Comment thread CONTRIBUTING.md Outdated
Comment thread AGENTS.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.


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

Comment thread docs/developer-onboarding.md Outdated
nickmoreton and others added 3 commits March 28, 2026 18:03
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…hore/repo-workflow-docs

# Conflicts:
#	docs/developer-onboarding.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.


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

Comment thread docs/developer-onboarding.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@nickmoreton nickmoreton merged commit 2751aa3 into main Mar 29, 2026
5 checks passed
@nickmoreton nickmoreton deleted the chore/repo-workflow-docs branch March 29, 2026 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants