This repository is ADEA's org-level configuration. It is not a product. Nothing here is built, released, or consumed at runtime.
| File | Purpose |
|---|---|
profile/README.md |
Renders on the organization's Overview tab. This is the only file in the repository that appears in public-facing docs. |
CONTRIBUTING.md |
Org-wide contribution defaults. Repositories with their own CONTRIBUTING.md keep it. |
CODE_OF_CONDUCT.md |
Contributor Covenant 2.1, enforced across every repository. |
SECURITY.md |
How to report a vulnerability. Applies org-wide. |
.github/ISSUE_TEMPLATE/ |
Issue forms inherited by repositories that do not define their own. |
GitHub renders profile/README.md from this repository on the organization
Overview tab. Two rules follow from that and are easy to get wrong:
- The path is
profile/README.md, notREADME.mdat the root. A rootREADME.mdrenders only when someone browses the repository itself. - The repository must be public and named exactly
.github. There is no other name that works.
Members of the organization see a member view of the profile. A separate
private .github-private repository with profile/README.md supplies that
view. We do not have one, so members and non-members currently see the same
public content.
GitHub merges these files by a fixed rule: the most specific repository wins.
A .github file in a repository overrides the one here, which means a
repository can deliberately opt out of anything in this table without anyone
editing this repository.
Every public repository currently ships its own AGENTS.md and pull request
template, and ui and themes also ship a CONTRIBUTING.md. Only
.github/ISSUE_TEMPLATE/ is inherited org-wide today,
because no repository defines issue forms.
These are not interchangeable, and GitHub does not say so when you get one wrong — the file is simply ignored.
| File type | Required location in this repository |
|---|---|
| Org profile | profile/README.md — the Overview tab reads nothing else |
Issue and pull request templates, config.yml |
.github/ISSUE_TEMPLATE/ |
| Everything else (CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, SUPPORT, FUNDING) | root, .github/, or docs/, in that order of precedence |
A label referenced by an issue template must also exist here, in the default
repository, as well as in every repository that uses the template. bug and
enhancement are both present.
git clone https://github.com/adea-ai/.github.git
cd .github
# edit, then
git commit -m "..." && git pushThe default branch is main. Pinned repositories are configured outside the
repository, on the organization profile page.