Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (57 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

77 lines (57 loc) · 3.28 KB
Raw

Contributing

Thanks for helping shape the future of agentic workloads on Cloud Foundry. During the current research phase there are two ways to contribute, both via pull request:

  • A quick idea in ideas/ — low bar, no sourcing required. A place for sparks, so nothing gets turned away for not yet being a full research note.
  • A sourced research note in research/ — structured and cited.

Ideas and research link together: an idea points to the research that backs it, and one research note can back several ideas. An idea with enough research behind it can later become a proposal.

For the why and the bigger picture, read IDEATION.md.

Adding an idea

Copy ideas/TEMPLATE.md to ideas/my-idea.md, jot down the spark, and open a PR. The only hard rules are a kebab-case filename and a title — everything else is optional. See ideas/README.md.

Adding a research note

  1. Fork this repository (or, if you're a working-group member with write access, create a branch).
  2. Copy the template: 
    cp research/TEMPLATE.md research/my-topic.md
  3. Fill it in. Keep it short, sourced, and outward-looking (see IDEATION.md for what Phase 1 is after). See research/README.md for the frontmatter schema.
  4. Commit your note: 
    git add research/my-topic.md
git commit -m "Add research note: my topic"
  5. Open a pull request. A CI check validates your note's frontmatter and structure. A working-group tech lead will give it a quick look and merge.

Filename convention

  • Lowercase kebab-case, ending in .md: research/agent-frameworks.md.
  • If your topic collides with an existing note, add your GitHub handle as a suffix: research/agent-frameworks-rkoster.md.

Frontmatter

Every note starts with a YAML frontmatter block. Required keys: title, author, date, tags, status, sources. The cf_areas key is optional. The full schema and field descriptions live in research/README.md.

Tagging well matters — tags are how the workshop clusters notes into themes. See the suggested (non-binding) vocabulary in IDEATION.md.

Review & merge

Research notes are low-risk, so we optimize for throughput:

  • For research notes, CI validates frontmatter, filename, and required sections. For ideas/ it only checks the filename and that a title is present.
  • Any working-group tech lead can merge once CI passes and the contribution is on-topic.
  • Substantive debate about the merits of a contribution happens at the workshop, not as a merge gate.

Contributor License Agreement (CLA)

All committers to a Cloud Foundry Foundation project must sign a Contributor License Agreement. You don't need to do anything up front: the EasyCLA bot comments on your first pull request with a link to sign (individual or corporate). Once it's signed, the CLA check goes green and your PR can be merged. You can also sign in to EasyCLA ahead of time.

Code of conduct

This project follows the Cloud Foundry Code of Conduct.