Add an AGENTS.md file

Open Beginner friendly
#4,677 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Create the proposed AGENTS.md file after reviewing PyGMT’s contributor and developer documentation. Summarize the project purpose and structure, development setup, testing requirements, coding and documentation conventions, and useful links. Done means the file gives AI coding agents repository-specific workflow guidance without requiring changes elsewhere.

Written by the indexing model from the issue text.

Description

discussions

As AI coding agents such as GitHub Copilot, Claude Code, Codex, and Cursor become more widely used, it may be helpful for PyGMT to provide an AGENTS.md file with repository-specific instructions.

The file could briefly describe:

  • The purpose and structure of PyGMT
  • How to set up a development environment
  • Testing requirements
  • Coding and documentation conventions
  • Useful links to contributor and developer documentation
  • More

Many projects are starting to adopt AGENTS.md files to help AI agents understand project workflows and produce contributions that better follow project standards.

References:

Dominant language
Python
Stars
874
Forks
255
Avg merge
2d 1h
Merged PRs (30d)
39

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.

More from GenericMappingTools/pygmt

All issues in GenericMappingTools/pygmt

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.