You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/contributing-code/github-repo-guidelines/contents.lr
+91-37
Original file line number
Diff line number
Diff line change
@@ -4,68 +4,122 @@ _template: page-with-toc.html
4
4
---
5
5
title: GitHub Repo Guidelines
6
6
---
7
-
description: This is a checklist for all public repositories hosted on the [Creative Commons GitHub organization](https://github.com/creativecommons). Not all repositories meet these criteria yet. Please notify us if a project you'd like to work on does not meet this checklist by opening a GitHub issue associated with the repository.
7
+
description: This is a checklist for all public repositories hosted on the
8
+
[Creative Commons GitHub organization](https://github.com/creativecommons). Not
9
+
all repositories meet these criteria yet. Please notify us if a project you'd
10
+
like to work on does not meet this checklist by opening a GitHub issue
11
+
associated with the repository.
8
12
---
9
13
body:
10
14
15
+
11
16
## Required Items
12
-
All GitHub repositories should have the following items to be considered fully ready for external contributors.
17
+
18
+
All GitHub repositories should have the following items to be considered fully
-`/.cc-metadata.yml`: The standard [CC metadata YAML file](#cc-metadata-file).
18
27
-`/CODE_OF_CONDUCT.md`: Code of Conduct
19
-
- Feel free to use our standard [`CODE_OF_CONDUCT.md`](https://github.com/creativecommons/vocabulary/blob/main/CODE_OF_CONDUCT.md) file from [creativecommons/.github](https://github.com/creativecommons/.github)
20
-
- [Adding a code of conduct to your project - GitHub Help](https://help.github.com/en/articles/adding-a-code-of-conduct-to-your-project)
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]
21
31
-`/LICENSE`: license file.
22
32
-`/CONTRIBUTING.md`: contributor guidelines
23
-
- Can be project-specific or our standard [`CONTRIBUTING.md`](https://github.com/creativecommons/vocabulary/blob/main/CONTRIBUTING.md) file from [creativecommons/.github](https://github.com/creativecommons/.github)
24
-
- [Setting guidelines for repository contributors - GitHub Help](https://help.github.com/en/articles/setting-guidelines-for-repository-contributors)
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]
25
37
-`/README.md`: read me information file
26
-
- Must documents how to install and build the project locally and documents a high level overview of the project and code structure. It should also link to any other available documentation.
27
-
-**All pull request templates must include the full text of the [DCO](https://developercertificate.org/)**.
38
+
- Must documents how to install and build the project locally and documents a
39
+
high level overview of the project and code structure. It should also link
40
+
to any other available documentation.
41
+
-**All pull request templates must include the full text of the [DCO][dco].**
- CI and code style linters that run automatically whenever new code is pushed (if applicable to the project).
53
+
54
+
- CI and code style linters that run automatically whenever new code is pushed
55
+
(if applicable to the project).
31
56
- At least a couple of automated tests (if applicable to the project).
32
57
58
+
33
59
## Optional items
34
60
35
-
-[Issue templates](https://help.github.com/en/articles/creating-issue-templates-for-your-repository). GitHub pulls the default templates from our [`.github` repository](https://github.com/creativecommons/.github) automatically, but if you want/need to customize them, create them in your repository.
36
-
- A [pull request template](https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository). GitHub pulls the default template from our [`.github` repository](https://github.com/creativecommons/.github) automatically, but if you want/need to customize it, create it in your repository.
37
-
-[Support resources](https://help.github.com/en/articles/adding-support-resources-to-your-project). GitHub pulls the default `SUPPORT.md` file from our [`.github` repository](https://github.com/creativecommons/.github) automatically, but if you want/need to customize it, create it in your repository.
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.
All repositories must contain a set of standard labels, [documented here](/contributing-code/repo-labels/), which comprise of common labels in addition to repository-specific skill labels.
42
-
You don't have to set these up manually. The labels are [automatically managed](https://github.com/creativecommons/ccos-scripts/tree/master/normalize_repos) on all CC repositories, and so, must not be renamed.
79
+
All repositories must contain a set of standard labels, [documented
80
+
here](/contributing-code/repo-labels/), which comprise of common labels in
81
+
addition to repository-specific skill labels. You don't have to set these up
82
+
manually. The labels are [automatically
83
+
managed](https://github.com/creativecommons/ccos-scripts) on all CC
84
+
repositories, and so, must not be renamed.
85
+
86
+
Repositories may contain additional custom labels as well which will remain
87
+
unaffected by the sync. It is recommended that custom labels be explained in
88
+
the contribution guidelines for that project.
43
89
44
-
Repositories may contain additional custom labels as well which will remain unaffected by the sync. It is recommended that custom labels be explained in the contribution guidelines for that project.
45
90
46
91
## Branch Protections
47
92
48
-
Branch protections are automatically set up by CC staff via [this script](https://github.com/creativecommons/ccos-scripts/tree/master/normalize_repos). By default, pushing directly to the `master` branch is disabled and all pull requests require review by at least one person before merge.
93
+
Branch protections are automatically set up by CC staff via
# Whether this repository should be featured on the CC Open Source site's "Projects" page
63
-
featured: false
64
-
# Slack channel name (optional key)
65
-
slack: 'cc-dev-catalog'
66
-
</code>
67
-
</pre>
68
-
69
-
This metadata file is used in the [Projects](/projects/) page. Repos that are marked as non-engineering projects are not displayed in the page and repos marked as featured as displayed at the top of the page. Repos should be marked as featured if we are actively looking for community contributions and have the bandwidth to review them quickly.
70
-
71
-
Repos without this metadata file are treated as `engineering_projects: true`, `featured: false` and `slack: ""`. A default is necessary since it will take time for us to clean up and add metadata to all our repos.
101
+
Each repo should have a `.cc-metadata.yml` file in the root directory with the
102
+
following structure:
103
+
104
+
```yaml
105
+
# Whether this GitHub repo is for a CC-led engineering project
0 commit comments