NCAS-CMS / NCAS-CMS/cf-plot

Add `AGENTS.md` file

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs enhancement
Dominant language
Python
Stars
21
Forks
11
Avg merge
7h 11m
Merged PRs (30d)
1

Description

Add an AGENTS.md file (see: https://github.com/agentsmd/agents.md) to the repo. This can initially be based on or pulled from notes created by @bnlawrence for work in PRs such as major refactors in #123 (see notably cf-plot-refactor-claude.pdf - but should be adapted in time to anticipate the best way to allow AI agents and those using them to contribute to the codebase in a useful way.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the AGENTS.md guidance at agentsmd.github.io and the notes in cf-plot-refactor-claude.pdf, especially those from PR #123. Create AGENTS.md with adapted contribution guidance for AI agents and their users; done means the repository contains useful, codebase-specific instructions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.