intial commit · github/github-ospo@2831f09 · GitHub
Skip to content

Commit 2831f09

Browse files
zkoppertzkoppert
committed
intial commit
0 parents  commit 2831f09

29 files changed

Lines changed: 917 additions & 0 deletions

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions

‎.github/ISSUE_TEMPLATE/Contribution_CLA.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Open Source Contribution
2+
description: Report a CLA, CAA, DCO, or other open source contribution
3+
title: Contribution to
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Use this for open source contributions when being asked to sign a Contributors License Agreement (CLA), Copyright Assignment Agreement (CAA), or Developer's Certificate of Origin (DCO).
9+
- type: textarea
10+
id: document
11+
attributes:
12+
label: Contribution Document
13+
description: Provide a link and PDF copy of the contribution document you are looking to sign.
14+
placeholder: include a link and PDF copy
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Contribution Description
21+
description: Provide a description of what you will be contributing, link to PR, and why.
22+
validations:
23+
required: true
24+
- type: dropdown
25+
id: small_code_exception
26+
attributes:
27+
label: Does your contribution meet the MSFT Small Code Exception?
28+
description: Your contribution is considered small code if it is a bug fix or trivial patch. See [MSFT Small Code Exception](https://docs.opensource.microsoft.com/policies/small-code-exception/) for more detail.
29+
options:
30+
- "Yes"
31+
- "No"
32+
validations:
33+
required: true
34+
- type: input
35+
id: previous_contribution
36+
attributes:
37+
label: Have other Hubbers signed or been authorized under the same contribition document you are requesting?
38+
placeholder: If yes, provide a link to the relevant prior issue.
39+
validations:
40+
required: false
41+
- type: input
42+
id: impact
43+
attributes:
44+
label: Are there any reasons why contributing to this project would give pause or have a negative business impact on GitHub?
45+
validations:
46+
required: true
47+
- type: input
48+
id: timeline
49+
attributes:
50+
label: Desired timeline
51+
validations:
52+
required: true
53+
- type: dropdown
54+
id: ccla
55+
attributes:
56+
label: Is your contribution document a Company Contributor License Agreement (CCLA)?
57+
description: If CCLA, please note contributor is responsible for administering and maintaining.
58+
options:
59+
- "Yes"
60+
- "No"
61+
validations:
62+
required: true

‎.github/ISSUE_TEMPLATE/open-source-release-form.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
3+
name: Open Source Software (OSS) Release
4+
description: File an open source release
5+
title: "Open Source: [org/project]"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this open source release form! Please answer all questions in this form to the best of your ability. Questions? Ping us in the [#open-source](https://github.slack.com/archives/C0E266M37) Slack channel. Read the full [open source release policy](https://github.com/github/open-source-releases/blob/main/release-policy.md) and [releasing documentation](https://github.com/github/open-source-releases/blob/main/releasing.md).
11+
12+
🛑 You do not need to fill out this open source release issue if:
13+
* The project is considered a [product release](https://github.com/github/open-source-releases/tree/ashleywolf-release-form#what-if-this-is-also-a-product-feature-release). Instead, create an issue in `github/releases` and cc: `@open-source` team.
14+
* You are creating this repository under your personal account (e.g. mikemcquaid/strap) and it's not used by GitHub or related to your work at GitHub.
15+
16+
🟢 You should fill this issue out if:
17+
* You are releasing an open source project related to your work (including field service projects).
18+
* You are publishing work related open source code under your personal account (e.g. mikemcquaid/strap) or a GitHub organization
19+
- type: dropdown
20+
attributes:
21+
label: Code and Assets
22+
description: Did your team write all the code and create all of the assets you are releasing (images, fonts, documentation, machine learning models, etc.)? If 3rd party code or code from another GitHub team is embedded in your release, you should answer No. If you are using a package manager to install dependencies ignored by version control, you can answer Yes. For licensing questions discuss with `github/legal` and add link to that issue in this issue
23+
options:
24+
- Yes, all created by my team
25+
- No, created by other teams
26+
- type: dropdown
27+
attributes:
28+
label: Data
29+
description: Does this project send any data or telemetry back to GitHub? If yes, open an issue in `github/privacy` and link to that issue in this issue
30+
options:
31+
- Yes, telemetry
32+
- No.
33+
- type: dropdown
34+
attributes:
35+
label: Cryptography
36+
description: Does the project implement cryptography? If yes, open an issue in `github/oss-legal-review` and link to that issue in this issue
37+
options:
38+
- Yes, implements cryptography
39+
- No.
40+
- type: dropdown
41+
attributes:
42+
label: Project License
43+
description: What license will you be releasing with? MIT is GitHub's preferred open source license unless a specific community requires a different license. If not MIT, open an issue in [github/legal](https://github.com/github/legal/issues/new/choose) and link to that issue in this issue
44+
options:
45+
- MIT License
46+
- Other
47+
- type: input
48+
attributes:
49+
label: Repo URL
50+
description: Provide the link to the repo URL
51+
placeholder: https://github.com/github/project-name
52+
- type: textarea
53+
attributes:
54+
label: Project description
55+
description: This information helps others understand what the project does
56+
value: |
57+
...
58+
- type: textarea
59+
attributes:
60+
label: Business case
61+
description: Describe the business goals that will help others understand the use case(s) for this project
62+
value: |
63+
...
64+
- type: input
65+
attributes:
66+
label: Owning Team
67+
description: "Name of the team that will own/maintain the project."
68+
placeholder: "@github/c2c-actions"
69+
- type: checkboxes
70+
attributes:
71+
label: Prepare Project
72+
options:
73+
- label: Review and address items in the [release guidelines](https://github.com/github/open-source-releases/blob/main/releasing.md)
74+
- label: Ensure the repo has a meaningful description, tags, release, packages, and link when applicable
75+
- label: Remove sensitive materials in the revision history, issues, or pull requests
76+
- label: "Add LICENSE file (preferred: [MIT LICENSE](https://github.com/github/open-source-releases/blob/main/templates/LICENSE.txt))"
77+
- label: Update README.md to include sections seen in [`README.md`](https://github.com/github/open-source-releases/blob/main/templates/README.md)
78+
- label: Add and update [`CODEOWNERS`](https://github.com/github/open-source-releases/blob/main/templates/CODEOWNERS) to list maintainers
79+
- label: Add and update CONTRIBUTING.md. Language specific templates are available (e.g. [CONTRIBUTING-ruby.md](https://github.com/github/open-source-releases/blob/main/templates/CONTRIBUTING-ruby.md), [CONTRIBUTING-go.md](https://github.com/github/open-source-releases/blob/main/templates/CONTRIBUTING-go.md))
80+
- label: Add and update [SUPPORT.md](https://github.com/github/open-source-releases/blob/main/templates/SUPPORT.md)
81+
- label: Add [`CODE_OF_CONDUCT.md`](https://github.com/github/open-source-releases/blob/main/templates/CODE_OF_CONDUCT.md)
82+
- label: Add [SECURITY.md](https://github.com/github/open-source-releases/blob/main/templates/SECURITY.md)
83+
- label: "Add branch protection rules to secure how branches are used. Examples: Require a pull request before merging; Require approvals on pull requests;"
84+
- type: checkboxes
85+
attributes:
86+
label: Support
87+
options:
88+
- label: Create a [Service Catalog entry](https://thehub.github.com/engineering/products-and-services/internal/service-catalog/service-ownership/#ownership-snippet)
89+
- label: Follow [best practices for maintainers](https://opensource.guide/best-practices/)
90+
- label: Join the GitHub maintainer community in [open-source discussions](https://github.com/github/open-source/discussions)
91+
- type: checkboxes
92+
attributes:
93+
label: Ship It
94+
options:
95+
- label: Reserve your project name on distribution platforms. If your project is Ruby, reserve the Rubygems gem name. If your project is Python, reserve the Pypi project. This will prevent confusion with namesquatting even if you don't plan to publish to these platforms.
96+
- label: Publish your project! [Open an issue in github/security-iam](https://github.com/github/security-iam/issues/new) referencing this github/open-source-releases issue with a request to switch the repo visibility to public.
97+
- label: Share your project! Post in `#open-source`, on your personal social channels, and the [GitHub Engineering blog](https://github.com/github/githubengineering).

‎.github/stale.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 60
5+
# Number of days of inactivity before a stale Issue or Pull Request is closed
6+
daysUntilClose: 7
7+
# Issues or Pull Requests with these labels will never be considered stale
8+
exemptLabels:
9+
- pinned
10+
- security
11+
# Label to use when marking as stale
12+
staleLabel: wontfix
13+
# Comment to post when marking as stale. Set to `false` to disable
14+
markComment: >
15+
This issue has been automatically marked as stale because it has not had
16+
recent activity. It will be closed if no further activity occurs. Thank you
17+
for your contributions.
18+
# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
19+
closeComment: false
20+
# Limit to only `issues` or `pulls`
21+
# only: issues

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 GitHub
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<img src="https://github.blog/wp-content/uploads/2020/03/github-open-source-erica.jpeg?resize=640%2C344" />
2+
3+
# github-ospo
4+
Helping open source program offices get started
5+
6+
The purpose of this repo is to enable new OSPOs to be successful on GitHub. On behalf of the GitHub OSPO we are sharing our policies, tools, and best practices to guide you through the first 6-12 months of your organization's open source journey. There are also other OSPO guides and resources available through [TODO](https://todogroup.org/) & [OSPO Alliance](https://ospo.zone/) as well as [opensource.guide](https://opensource.guide/). This repo will focus on GitHub related tools and content.
7+
8+
## Directory
9+
10+
- [Policies](./policies)
11+
- [Releasing open source steps](./policies/releasing.md)
12+
- [Releasing open source policy](./policies/release-policy.md)
13+
- [Contributor license agreements](./policies/contributor-license-agreements.md)
14+
- [License compliance](./policies/licensing.md)
15+
- [Small code exceptions](./policies/small-code-exception.md)
16+
- [Guides](./docs)
17+
- [Archiving repos](./docs/archiving-public-repositories.md)
18+
- [Sponsoring Open Source](./docs/foundations.md)
19+
- [OSPO Tools & External Guides](./docs/ospo-tools-and-external-guides.md)
20+
- [Commercial licenses](./docs/commercial-licenses.md)
21+
- [Maximize your open source presence on GitHub](./docs/org-presence-on-github.md)
22+
- [Internal OSPO newsletters](./newsletter%20template)
23+
24+
### Maintainers
25+
26+
GitHub OSPO team
27+
28+
### Contributions
29+
30+
We welcome all contributions. Please open an issue in the repo.
31+
32+
### License
33+
34+
This repo is licensed under MIT for code and CC BY-SA 4.0 for documentation.

‎docs/archiving-public-repositories.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
We have an archived repositories feature to indicate and make unmaintained repositories read-only.
2+
3+
In order to archive a github organization repository:
4+
5+
1. Edit the README to add a note:
6+
7+
```
8+
**NOTE**: _This repository is no longer supported or updated by GitHub. If you wish to continue to develop this code yourself, we recommend you fork it._</code>
9+
```
10+
11+
2. Then open a pull request with that change. Here's the text we've been using for the pull request:
12+
13+
```
14+
This repository is no longer being maintained. This pull request makes it explicit in the `README.md`. Let me know if you have any reservations, otherwise I'm going to archive this repository.
15+
16+
/cc any relevant teams or recent GitHub committers
17+
```
18+
19+
3. Let it sit until you receive confirmation from a maintainer or an adequate length of time has passed.
20+
21+
4. Close all open issues and pull requests and archive the repository from the repository settings.

‎docs/commercial-licenses.md‎

Lines changed: 5 additions & 0 deletions

0 commit comments

Comments
 (0)