Skip to content

Commit

Permalink
📝 update health files guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ctcpip committed Jul 19, 2024
1 parent 77b60b2 commit 29175c8
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions project-resources/community-health-files-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,46 @@

Community health files are documents related to project collaboration. Most commonly, these include:

- `CHARTER.md`
- `CODE_OF_CONDUCT.md`
- `CONTRIBUTING.md`
- `GOVERNANCE.md`
- `SECURITY.md`

> [!NOTE]
> See the [full list](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types) of supported default community health files
## Default Community Health Files
## Default Community Health Files (GitHub Feature)

Instead of adding these files to every repository within an organization, we can add them only once to a special organization repository which must be named `.github`. GitHub will automatically use the community health files specified at this location by default for all repositories within the organization.
For projects hosted on GitHub, instead of adding these files to every repository within an organization, we can add them only once to a special organization repository which must be named `.github`. GitHub will automatically use the community health files specified at this location by default for all repositories within the organization.

The filenames must match [what is expected by GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types) and must be in one of these locations:
The filenames must match [what is expected by GitHub][supported] and must be in one of these locations:

- The root of the `.github` repository
- The `.github` folder in the `.github` repository
- The `docs` folder in the `.github` repository

> [!TIP]
> We recommend placing these files in the root of the `.github` repository
Where possible, it is best to have only one file for each type of community health file, specified in the `.github` repository, and to avoid having individual files for each repository. However, specific project needs may require repository-specific files.

> [!Important]
> [!IMPORTANT]
> If a file also exists in a repository, then that file will take precedence over the organization default.
### Community Health Files That Projects Should Have

- Organizations/projects must have at least `CODE_OF_CONDUCT.md` and `SECURITY.md` files.
- A [`CONTRIBUTING.md`](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) file is highly recommended for all organizations/projects.
- A `GOVERNANCE.md` file should be provided for all organizations/projects with formal governance.
These files are [required for all OpenJS Foundation projects][required]:

- `CODE_OF_CONDUCT.md`
- `SECURITY.md`
- `CHARTER.md`
- Note: it is not possible to provide a default CHARTER.md file for the organization. See the [full list][supported] of supported default community health files.
- Instead of duplicating the content, consider using a centralized `CHARTER.md` file, and then linking to that file from the `CHARTER.md` files in other repositories.

A `GOVERNANCE.md` file should be provided for all organizations/projects with formal governance and is [required for OpenJS Foundation Impact projects][required]

A [`CONTRIBUTING.md`](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) file is highly recommended for all organizations/projects.

> [!NOTE]
> All projects must have a LICENSE file, but it is not possible to provide a default LICENSE file for the organization. Every repository requires its own LICENSE file.
> All projects [must have a LICENSE file][license], but it is not possible to provide a default LICENSE file for the organization. Every repository requires its own LICENSE file.
#### `CODE_OF_CONDUCT.md`

Expand All @@ -59,3 +68,7 @@ Another good resource is the [OpenSSF Guide to implementing a coordinated vulner
## Further Resources on Best Practices

Community health files are one aspect of best practices that projects should follow. For more information on best practices, see the [OpenSSF Best Practices Badge Guide](https://github.com/openjs-foundation/security-collab-space/blob/main/best-practices-badge.md).

[license]: https://github.com/openjs-foundation/cross-project-council/blob/main/governance/IP_POLICY_GUIDANCE.md#basic-requirements
[required]: https://github.com/openjs-foundation/cross-project-council/blob/main/PROJECT_PROGRESSION.md#onboarding-checklist
[supported]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types

0 comments on commit 29175c8

Please sign in to comment.