Skip to content

Commit cf3fd4c

Browse files
authored
Merge branch 'main' into fix/711-update-footer-width
2 parents 5a2b25f + 30e1498 commit cf3fd4c

File tree

4 files changed

+87
-67
lines changed

4 files changed

+87
-67
lines changed

content/contributing-code/contents.lr

+13-6
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ are some of the ones that are most relevant to finding a good issue to work on:
3232
- You do not need our permission to work on one of these issues.
3333
- You may work on an issue labeled <span class="gh-label friendliness">good
3434
first issue</span> even if it's not your first issue.
35+
- Please don't ask for issue assignment or claim issues. Do the work and
36+
submit a pull request (PR).
37+
- Even if multiple people submit PRs for the same issue, multiple ideas and
38+
implementations strengthen the final product.
39+
- For work program applicants, each can all list their own PRs on their
40+
application. It is the quality of work that is important, not whether it
41+
is merged.
3542
- **Issues not available for community contribution:**
3643
- The following tags mark issues that are _not_ open for community
3744
contribution:
@@ -81,12 +88,10 @@ on.
8188
Once you've found an issue you'd like to work on, please follow these steps to
8289
make your contribution:
8390

84-
1. Comment on it and say you're working on that issue. This is to avoid
85-
conflicts with others also working on the issue. If you've followed the
86-
guidelines above, you don't need to ask permission to start work on an
87-
issue.
88-
2. Write your code and submit your pull request. Be sure to read and follow our
89-
**[pull request guidelines](/contributing-code/pr-guidelines/)!**
91+
1. If you have followed the guidelines above, you don't need to ask permission
92+
to start work on an issue.
93+
2. Write your code and submit your pull request (PR). Be sure to read and
94+
follow our **[pull request guidelines](/contributing-code/pr-guidelines/)!**
9095
3. Wait for code review and address any issues raised as soon as you can.
9196

9297
**A note on collaboration:** We encourage people to collaborate as much as
@@ -123,3 +128,5 @@ When in doubt, ask a question on [one of our community forums](/community/).
123128
Recurring donations to Creative Commons Open Source can be made via [Sponsor
124129
@creativecommons on GitHub
125130
Sponsors](https://github.com/sponsors/creativecommons).
131+
132+
Thank you to our [Supporters](/supporters/)!

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

+71-43
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
38-
- Must documents how to install and build the project locally and documents a
61+
- `/README.md`: repository information file
62+
- begin with an H1 heading identical to repository name followed by a
63+
repository description
64+
- Must document 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:
@@ -106,8 +134,8 @@ following structure:
106134
engineering_project: true
107135
# Name of the repository/project in English
108136
english_name: CC Catalog API
109-
# All technologies used
110-
technologies: Python, Django, Django REST Framework, Elasticsearch
137+
# All technologies used, sorted
138+
technologies: Django, Django REST Framework, Elasticsearch, Python
111139
# Whether this repository should be featured on the CC Open Source site's "Projects" page
112140
featured: false
113141
# Slack channel name (optional key)

content/programs/project-ideas-collection/ansible-dev-env/contents.lr

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ application_tips:
4242
- [Applicant Guide](/programs/applicant-guide/)
4343
---
4444
resources:
45+
- [creativecommons/ansible-dev](https://github.com/creativecommons/ansible-dev) Ansible development environment.
4546
- [Ansible Documentation](https://docs.ansible.com/)
4647
- [FrontPage - Debian Wiki](https://wiki.debian.org/FrontPage)
4748
- [Docker Docs](https://docs.docker.com/)

databags/repos.json

+2-18
Original file line numberDiff line numberDiff line change
@@ -199,22 +199,6 @@
199199
"url": "https://github.com/creativecommons/cc-resource-archive",
200200
"website": "https://resources.creativecommons.org/"
201201
},
202-
{
203-
"created": "2013-12-02T21:01:41+00:00",
204-
"description": "Legacy API to integrate the Creative Commons licensing engine into third party applications",
205-
"engineering_project": true,
206-
"featured": false,
207-
"id": 14874742,
208-
"language": "Python",
209-
"license": {
210-
"name": "MIT License",
211-
"url": "https://github.com/creativecommons/cc.api/blob/main/LICENSE"
212-
},
213-
"name": "cc.api",
214-
"slack": "",
215-
"url": "https://github.com/creativecommons/cc.api",
216-
"website": "https://api.creativecommons.org/docs/"
217-
},
218202
{
219203
"created": "2014-10-06T22:07:52+00:00",
220204
"description": "RubyCAS customizations for CCID (Creative Commons ID)",
@@ -841,7 +825,7 @@
841825
"english_name": "CC Vocabulary",
842826
"featured": false,
843827
"id": 224004769,
844-
"language": "SCSS",
828+
"language": "MDX",
845829
"license": {
846830
"name": "MIT License",
847831
"url": "https://github.com/creativecommons/vocabulary/blob/main/LICENSE"
@@ -889,7 +873,7 @@
889873
"english_name": "CC Vocabulary fonts",
890874
"featured": false,
891875
"id": 446389251,
892-
"language": "JavaScript",
876+
"language": "MDX",
893877
"license": {
894878
"name": "MIT License",
895879
"url": "https://github.com/creativecommons/vocabulary-fonts/blob/main/LICENSE"

0 commit comments

Comments
 (0)