# Files changed · PR \#55 · screen/col
[View on GitCafe](https://git.cafe/screen/col/pull/55/diffs)
Repository: [screen/col](https://git.cafe/screen/col)
Visibility: public
[Document contributor PR and discovery requirements](https://git.cafe/screen/col/pull/55.md)
Version: 0
Head commit: d184d3b0ee147e52dbef923be5062198aa5e024c
Base commit: e4fe2298d470b5b714e9ef1c1b73a5c89ae0dcb0
Comparison base: e4fe2298d470b5b714e9ef1c1b73a5c89ae0dcb0
Showing up to 20 entries from this revision. If the pull request changes, reopen the first page before continuing.
## \.github/PULL_REQUEST_TEMPLATE.md
Status: modified; +12; −1
```diff
@@ -1,6 +1,8 @@
## What changed
+
+
## Type
@@ -14,11 +16,18 @@
## Verification
- [ ] I kept this pull request focused.
+- [ ] I ran the relevant checks from CONTRIBUTING.md and listed the commands and results below.
+- [ ] I reviewed my diff, including any AI-generated code, for accidental files, debug output, secrets, and unrelated changes.
-- [ ] I ran `npm test` and `npm run build` successfully.
- [ ] I checked light and dark modes when the interface changed.
+- [ ] I checked mobile layouts when the interface changed.
- [ ] I checked keyboard access and reduced motion when interaction changed.
- [ ] I added screenshots or a recording for visible changes.
+- [ ] If I added a major feature, I included usage and setup documentation, linked it from `/docs`, and updated the README where needed.
+- [ ] For catalog, public page, or agent capability changes, I verified `llms.txt`, `robots.txt`, and the sitemap, and updated affected metadata and agent guides.
+- [ ] If this PR fully resolves an issue, I added a closing reference below. Partial fixes use `Refs #`.
+
+
## Library submissions
@@ -32,4 +41,6 @@
## Related issue
+
+
Closes #
```
## CONTRIBUTING.md
Status: modified; +25; −2
````diff
@@ -7,7 +7,7 @@
- Search existing [issues](https://github.com/screen-gd/Col/issues) and [pull requests](https://github.com/screen-gd/Col/pulls).
- Use an issue form for a library request, feature request, or bug report.
- Keep each issue and pull request focused on one outcome.
-- For a larger product or design change, open an issue before implementation.
+- For a major feature, redesign, or new dependency, open an issue and get Screen's agreement before implementation.
## Local setup
@@ -18,7 +18,7 @@
npm run dev
```
-Run `npm run build` before submitting changes.
+For code or catalog changes, run `npm run typecheck` and `npm test` before submitting. `npm test` includes the production build. For documentation-only changes, check links and formatting; if the documentation is a site page, also run `npm run build`.
## Add a library
@@ -71,7 +71,21 @@
- Keep copy short and specific.
- Update comments and documentation affected by the change.
- Add a focused test when the behavior has a stable test seam.
+- For a bug fix, include reproduction steps, expected behavior, and how to verify the fix.
+- Explain why a new dependency is needed and include the matching lockfile change.
+## Keep discovery up to date
+
+When adding or changing libraries, components, integrations, public pages, or features that agents can use, update all affected discovery outputs in the same pull request:
+
+- [`app/llms.txt/route.ts`](app/llms.txt/route.ts) generates `/llms.txt`. Library and integration entries come from catalog data automatically. Update the generator when new features, links, or agent instructions need to appear.
+- [`app/sitemap.ts`](app/sitemap.ts) generates `/sitemap.xml`. Library and integration pages are included automatically. Add new public pages to `staticRoutes` in [`lib/site.ts`](lib/site.ts).
+- [`app/robots.ts`](app/robots.ts) generates `/robots.txt`. Check that crawler rules and the sitemap URL still cover the change. Update them when crawl access changes.
+- Update affected page titles, descriptions, canonical URLs, social metadata, and structured data.
+- Keep the [agent guide](app/docs/agents/page.tsx), MCP server guides, and MCP server tool descriptions and results consistent with any changes to agent capabilities.
+
+Edit the source data or generators, then verify the generated output. Catalog additions do not require manual copies in each file. Keep [`tests/discovery.test.mjs`](tests/discovery.test.mjs) current when routes or discovery behavior change, and explain any discovery outputs that do not need changes in the PR description.
+
## Pull requests
Use a descriptive title, such as:
@@ -82,4 +96,13 @@
In the description, explain what changed, why it changed, and how it was verified. Add screenshots for visible interface changes.
+- Use a draft pull request while work is incomplete. Mark it ready for review after implementation, documentation, and relevant checks are complete.
+- List the verification commands and results. Check mobile layouts for interface changes and include before-and-after screenshots where applicable.
+- Review your own diff for accidental files, debug output, secrets, and unrelated formatting changes. You are responsible for all submitted code, including code generated by AI.
+- Every new major feature must include user documentation in the same pull request. Explain how to use it and any required setup, and link it from the site's `/docs` page, following the Col MCP guides. Update the README when the feature affects the project overview or setup.
+- If the pull request fully resolves an issue, include `Closes #123` in the description. For a partial fix, use `Refs #123` and describe the remaining work. Keep the issue open until merge. GitHub automatically closes linked issues when the PR merges into the default branch with auto-closing enabled. Screen confirms completion after merge.
+- Respond to review comments with the change you made or your reasoning. Flag substantial changes made after review so Screen can review them again.
+
+Screen is the only person who merges pull requests for now. Contributors submit changes for review and leave merging to Screen.
+
Reviewers may request metadata corrections, a smaller scope, accessibility fixes, or links to official sources before merging.
````
## app/docs/pull-requests/page.tsx
Status: modified; +9; −2
```diff
@@ -16,15 +16,22 @@
Fork the repository, create a focused branch, and keep unrelated changes out. Library additions belong in data/libraries.ts with a unique kebab-case slug, canonical URL, factual description, and existing taxonomy values where possible.
+ Get Screen's agreement before starting a major feature, redesign, or adding a dependency. Keep unfinished pull requests in draft.
+
+ Major features need usage and setup documentation linked from /docs. For library, component, integration, public page, or agent capability changes, verify llms.txt, robots.txt, and the sitemap. Update affected generators, page metadata, and agent guides in the same pull request. Library and integration entries are generated from catalog data.
+
+
Run these from the repository root before you open the pull request.
+
-
+ Tests include the production build. Check mobile layouts, light and dark modes, and keyboard access when the interface changes. Review your own diff, including any code generated by AI.
+ Explain what changed, why it changed, and how you verified it. List check results and include screenshots for visible interface changes. For bug fixes, include reproduction steps and expected behavior.
- Explain what changed, why it changed, and how you verified it. Include screenshots for visible interface changes.
+ Use Closes #123 when the PR fully resolves an issue, or Refs #123 for a partial fix. Screen reviews and merges all pull requests and confirms issue completion after merge.
Read the contribution guide
```