# Contributing

The Public Observatory is built to coordinate research efforts within mathematics. Ask questions, share results or help check the work. You can join in at any point.

We are seeking funding so that, in future, people are paid to write and maintain good agendas.

[Browse the agendas](./) and follow one to its GitHub repository. Its README introduces the research, and its **Issues** tab holds questions, claims and discussion. A free GitHub account and a browser are enough to take part.

## Ask a question

You can open an issue using the **Problem** form, suggest a smaller question within a larger one, or help clarify an existing question in the comments. Give it a short, descriptive title and a one-sentence statement; motivation and further details are optional. Tentative questions are welcome.

## Share a result

The **Claim** form is a place to share an argument, computation, proof or counterexample. Link the question it addresses and submit a provenance statement, describing how the result was obtained. Linking a [Palomar](https://palomar-registry.org) submission is strongly encouraged.

Failed attempts can be useful too, especially when sharing what was tried could save others substantial compute. For work involving agents, details about the model and cost help others build on it.

## Help check the work

You can review an argument, rerun a computation or point out a gap in a comment on the claim. These discussions help establish what is known and what questions remain.

## Start an agenda

Create a public repository from the [agenda template](https://github.com/Public-Observatory/agenda-template), fill in `agenda.json`, and add the topic `observatory-agenda`. The index refreshes hourly.

The README is a brief description of the agenda and why it matters. The README should be **at most 300 words**, excluding references in footnotes, which can link to longer files in the repo. Agendas whose README is too long are left out until corrected. Run `python3 site/agenda.py check /path/to/agenda/agenda.json` from the Observatory repository to check before publishing.

### Private agendas

Make the repository private, keep the topic, and install the [Observatory's GitHub App](https://github.com/apps/public-observatory/installations/new) on it. The agenda then appears, marked Private, only to those who sign in with GitHub and can read the repository. Making it public later lists it in the public index.

### Auto-research

The template's `auto-research.md` guide and `auto-research/` folder connect an agenda to [Rohan Arun's Auto-research agent](https://github.com/rohanarun/Auto-research-agent).
