Skip to content

Commit 252ccf5

Browse files
committed
correct urls following ccos-scripts reorg and tidy formatting
1 parent dd4328c commit 252ccf5

File tree

1 file changed

+91
-37
lines changed
  • content/contributing-code/github-repo-guidelines

1 file changed

+91
-37
lines changed

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

+91-37
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,122 @@ _template: page-with-toc.html
44
---
55
title: GitHub Repo Guidelines
66
---
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.
812
---
913
body:
1014

15+
1116
## 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
19+
ready for external contributors.
20+
1321

1422
### Files
23+
1524
- `/.github/CODEOWNERS`: Defined code owners
16-
- [About code owners - GitHub Help](https://help.github.com/en/articles/about-code-owners)
25+
- [About code owners - GitHub Help][about-owners]
1726
- `/.cc-metadata.yml`: The standard [CC metadata YAML file](#cc-metadata-file).
1827
- `/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]
2131
- `/LICENSE`: license file.
2232
- `/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]
2537
- `/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].**
42+
43+
[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+
2851

2952
### Additional Items
30-
- 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).
3156
- At least a couple of automated tests (if applicable to the project).
3257

58+
3359
## Optional items
3460

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.
70+
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
75+
3876

3977
## Standard Labels
4078

41-
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.
4389

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.
4590

4691
## Branch Protections
4792

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
94+
[creativecommons/ccos-scripts](https://github.com/creativecommons/ccos-scripts).
95+
By default, pushing directly to the *default branch* (ex. `main`) is disabled
96+
and all pull requests require review by at least one person before merge.
97+
4998

5099
## CC Metadata file
51100

52-
Each repo should have a `.cc-metadata.yml` file in the root directory with the following structure:
53-
54-
<pre>
55-
<code>
56-
# Whether this GitHub repo is for a CC-led engineering project
57-
engineering_project: true
58-
# Name of the repository/project in English
59-
english_name: CC Catalog API
60-
# All technologies used
61-
technologies: Python, Django, Django REST Framework, Elasticsearch
62-
# 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
106+
engineering_project: true
107+
# Name of the repository/project in English
108+
english_name: CC Catalog API
109+
# All technologies used
110+
technologies: Python, Django, Django REST Framework, Elasticsearch
111+
# Whether this repository should be featured on the CC Open Source site's "Projects" page
112+
featured: false
113+
# Slack channel name (optional key)
114+
slack: 'cc-dev-catalog'
115+
```
116+
117+
This metadata file is used in the [Projects](/projects/) page. Repos that are
118+
marked as non-engineering projects are not displayed in the page and repos
119+
marked as featured as displayed at the top of the page. Repos should be marked
120+
as featured if we are actively looking for community contributions and have the
121+
bandwidth to review them quickly.
122+
123+
Repos without this metadata file are treated as `engineering_projects: true`,
124+
`featured: false` and `slack: ""`. A default is necessary since it will take
125+
time for us to clean up and add metadata to all our repos.

0 commit comments

Comments
 (0)