Skip to content

Add automation tools to generated projects #71

Description

@demccormack

Book projects generated using this tool should have:

  • a PDF preview workflow identical to the one on this repo, with the book name substituted instead of the sample name
  • a Copilot instructions file with the following content, substituting the correct title and author:
# Copilot Instructions

## Project overview

This repository contains the LaTeX source for *The Verse Awakens*, a book being written by Daniel McCormack.

The content of the book is written by the author. Copilot's role in this repository is solely technical: maintaining and improving the LaTeX code, document structure, build system, and supporting tooling.

## Important: preserve the author's writing

Self-expression is a sacred act. The author's words are theirs, and theirs alone.

Do not rewrite, edit, "improve", modernise, correct, or otherwise alter the wording of the book unless the prompt or issue explicitly asks for a textual change.

This includes apparent:
- spelling or grammatical errors
- unusual punctuation
- unconventional capitalisation
- whitespace or line-break choices
- repeated words or phrases

These may be deliberate choices. You may provide feedback on spelling or grammar, but do not make alterations.

When a task concerns layout or typesetting, change the LaTeX markup rather than the text wherever possible.

## LaTeX

The project is built using `latexmk`.

Before completing a change, build the project and verify that the
document compiles successfully.

Use:

    latexmk -pdf main.tex

unless the repository's existing configuration specifies a different build command.

Follow the existing LaTeX structure and conventions rather than introducing new packages or abstractions unnecessarily.

Prefer:
- simple, idiomatic LaTeX
- semantic commands over repeated formatting markup
- reusable commands/environments when formatting is genuinely shared
- small changes appropriate to the issue being addressed

Avoid:
- unnecessary dependencies
- large-scale restructuring unrelated to the issue
- generated PDF/build artifacts in Git unless the repository already intentionally tracks them

## Scope of agent work

Copilot may autonomously make technical changes such as:

- document layout and typography
- page and section formatting
- poem-specific LaTeX environments and commands
- table of contents behaviour
- headers and footers
- title/front-matter formatting
- page breaks and spacing
- build configuration
- `.gitignore`
- LaTeX warnings and errors
- refactoring repeated LaTeX markup
- scripts or tooling supporting the document build

If a technical task would require changing the actual words of the book, preserve the text and explain the limitation instead.

## Working on issues

Treat the GitHub issue as the specification for the task.

Keep changes focused on that issue. Do not opportunistically rewrite unrelated parts of the project.

Inspect the existing implementation before deciding how to solve the problem. Preserve established conventions unless the issue specifically calls for changing them.

After making changes:

1. Build the complete document with `latexmk`.
2. Check the build output for relevant errors or warnings.
3. Confirm that the requested behaviour has been implemented.
4. Summarise the technical changes made and any significant design decisions.

When visual appearance is relevant, make conservative changes unless the issue provides explicit design requirements.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions