Skip to content

Commit 6405749

Browse files
committed
update repo guidelines
1 parent 5e7a91d commit 6405749

File tree

1 file changed

+68
-40
lines changed
  • content/contributing-code/github-repo-guidelines

1 file changed

+68
-40
lines changed

content/contributing-code/github-repo-guidelines/contents.lr

+68-40
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,40 @@ associated with the repository.
1313
body:
1414

1515

16-
## Required Items
16+
## Organizational defaults
17+
18+
The following organizational defaults are automatically applied to all
19+
repositories (per [Creating a default community health file - GitHub
20+
Docs][health-files]). Most repositories _shouldn't_ have their own copies of
21+
these files:
22+
- [`.github/PULL_REQUEST_TEMPLATE.md`][pr-template]: Pull request template
23+
- All pull request templates _must_ include the full text of the [DCO][dco].
24+
- [`.github/ISSUE_TEMPLATE/bug_report.md`][issue-template-bug]: Bug report
25+
issue template
26+
- [`.github/ISSUE_TEMPLATE/feature_request.md`][issue-template-feature]:
27+
Feature request issue template
28+
- [`CODE_OF_CONDUCT.md`][conduct]: Code of Conduct
29+
- [Adding a code of conduct to your project - GitHub Help][help-conduct]
30+
- [`CONTRIBUTING.md`][contributing]: contributor guidelines
31+
- [Setting guidelines for repository contributors - GitHub
32+
Help][setting-guidelines]
33+
- [`FUNDING.yml`][funding]: Displays a sponsor button
34+
- [`SUPPORT.md`][support]: Documentation on how to get help
35+
36+
[health-files]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
37+
[pr-template]: https://github.com/creativecommons/.github/blob/main/.github/PULL_REQUEST_TEMPLATE.md
38+
[dco]: https://developercertificate.org/
39+
[issue-template-bug]: https://github.com/creativecommons/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md
40+
[issue-template-feature]: https://github.com/creativecommons/.github/blob/main/.github/ISSUE_TEMPLATE/feature_request.md
41+
[conduct]: https://github.com/creativecommons/vocabulary/blob/main/CODE_OF_CONDUCT.md
42+
[help-conduct]: https://help.github.com/en/articles/adding-a-code-of-conduct-to-your-project
43+
[contributing]: https://github.com/creativecommons/vocabulary/blob/main/CONTRIBUTING.md
44+
[setting-guidelines]: https://help.github.com/en/articles/setting-guidelines-for-repository-contributors
45+
[funding]: https://github.com/creativecommons/.github/blob/main/FUNDING.yml
46+
[support]: https://github.com/creativecommons/.github/blob/main/SUPPORT.md
47+
48+
49+
## Required items
1750

1851
All GitHub repositories should have the following items to be considered fully
1952
ready for external contributors.
@@ -24,57 +57,52 @@ ready for external contributors.
2457
- `/.github/CODEOWNERS`: Defined code owners
2558
- [About code owners - GitHub Help][about-owners]
2659
- `/.cc-metadata.yml`: The standard [CC metadata YAML file](#cc-metadata-file).
27-
- `/CODE_OF_CONDUCT.md`: Code of Conduct
28-
- Feel free to use our standard [`CODE_OF_CONDUCT.md`][conduct] file from
29-
[creativecommons/.github][dot-github]
30-
- [Adding a code of conduct to your project - GitHub Help][help-condcut]
3160
- `/LICENSE`: license file.
32-
- `/CONTRIBUTING.md`: contributor guidelines
33-
- Can be project-specific or our standard [`CONTRIBUTING.md`][contributing]
34-
file from [creativecommons/.github][dot-github]
35-
- [Setting guidelines for repository contributors - GitHub
36-
Help][setting-guidelines]
37-
- `/README.md`: read me information file
61+
- `/README.md`: repository information file
62+
- begin with an H1 heading identical to repository name followed by a
63+
repository description
3864
- Must documents how to install and build the project locally and documents a
3965
high level overview of the project and code structure. It should also link
4066
to any other available documentation.
41-
- **All pull request templates must include the full text of the [DCO][dco].**
67+
- Must document the Code of Conduct. For example, see the [Code of
68+
Conduct][section-coc] `README.md` section in
69+
`creativecommons/index-dev-env`.
70+
- Must document Contributing. For example, see the
71+
[Contributing][section-contrib] `README.md` section in
72+
`creativecommons/index-dev-env`.
4273

4374
[about-owners]: https://help.github.com/en/articles/about-code-owners
44-
[conduct]: https://github.com/creativecommons/vocabulary/blob/main/CODE_OF_CONDUCT.md
45-
[dot-github]: https://github.com/creativecommons/.github
46-
[help-condcut]: https://help.github.com/en/articles/adding-a-code-of-conduct-to-your-project
47-
[contributing]: https://github.com/creativecommons/vocabulary/blob/main/CONTRIBUTING.md
48-
[setting-guidelines]: https://help.github.com/en/articles/setting-guidelines-for-repository-contributors
49-
[dco]: https://developercertificate.org/
50-
75+
[section-coc]: https://github.com/creativecommons/index-dev-env/blob/main/README.md#code-of-conduct
76+
[section-contrib]: https://github.com/creativecommons/index-dev-env/blob/main/README.md#contributing
5177

52-
### Additional Items
5378

54-
- CI and code style linters that run automatically whenever new code is pushed
55-
(if applicable to the project).
56-
- At least a couple of automated tests (if applicable to the project).
79+
## Additional items
5780

81+
As applicable or appropriate, each repository should include:
82+
- GitHub Actions for formatting, linting, styling, etc.
83+
- GitHub Actions for unit tests
5884

59-
## Optional items
6085

61-
- [Issue templates][issue-templates]. GitHub pulls the default templates from
62-
our [`.github` repository][dot-github] automatically, but if you want/need to
63-
customize them, create them in your repository.
64-
- A [pull request template][pr-template]. GitHub pulls the default template
65-
from our [`.github` repository][dot-github] automatically, but if you
66-
want/need to customize it, create it in your repository.
67-
- [Support resources][support-resources]. GitHub pulls the default `SUPPORT.md`
68-
file from our [`.github` repository][dot-github] automatically, but if you
69-
want/need to customize it, create it in your repository.
86+
## Repository configuration
7087

71-
[issue-templates]: https://help.github.com/en/articles/creating-issue-templates-for-your-repository
72-
[dot-github]: https://github.com/creativecommons/.github
73-
[pr-template]: https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository
74-
[support-resources]: https://help.github.com/en/articles/adding-support-resources-to-your-project
88+
- Main page: About ⚙️ (Edit repository details)
89+
- Description should match `README.md`
90+
- Add appropriate Topics
91+
- Disable/Uncheck any of the "Include in home page" that are not relevant to
92+
the repository (ex. if no packages are provided, uncheck Packages).
93+
- Settings: General
94+
- Features
95+
- Disable/Uncheck Wikis unless you are going to use that feature
96+
- Disable/Uncheck Discussions unless you are going to use that feature
97+
- Disable/Uncheck Projects unless you are going to use that feature
98+
- Pull Requests
99+
- Enable/check Automatically delete head branches
100+
- Settings: Collaborators and teams
101+
- Ensure, at a minimum that the team in `/.github/CODEOWNERS` has write
102+
permissions
75103

76104

77-
## Standard Labels
105+
## Standard labels
78106

79107
All repositories must contain a set of standard labels, [documented
80108
here](/contributing-code/repo-labels/), which comprise of common labels in
@@ -88,15 +116,15 @@ unaffected by the sync. It is recommended that custom labels be explained in
88116
the contribution guidelines for that project.
89117

90118

91-
## Branch Protections
119+
## Branch protections
92120

93121
Branch protections are automatically set up by CC staff via
94122
[creativecommons/ccos-scripts](https://github.com/creativecommons/ccos-scripts).
95123
By default, pushing directly to the *default branch* (ex. `main`) is disabled
96124
and all pull requests require review by at least one person before merge.
97125

98126

99-
## CC Metadata file
127+
## CC metadata file
100128

101129
Each repo should have a `.cc-metadata.yml` file in the root directory with the
102130
following structure:

0 commit comments

Comments
 (0)