|
| 1 | +--- |
| 2 | + |
| 3 | +name: Open Source Software (OSS) Release |
| 4 | +description: File an open source release |
| 5 | +assignees: ashleywolf, zkoppert |
| 6 | +title: "Open Source: [org/project]" |
| 7 | +body: |
| 8 | + - type: markdown |
| 9 | + attributes: |
| 10 | + value: | |
| 11 | + 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 `here`. Read the full open source release policy and releasing documentation. |
| 12 | +
|
| 13 | + 🛑 You do not need to fill out this open source release issue if: |
| 14 | + * The project is considered a product release that is not open source-related |
| 15 | + * 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. |
| 16 | +
|
| 17 | + 🟢 You should fill this issue out if: |
| 18 | + * The project is considered an open source-related product release. Make sure to create an issue in `@/releases` first! |
| 19 | + * You are releasing an open source project related to your work (including field service projects). |
| 20 | + * You are publishing work-related open source code under your personal account (e.g. mikemcquaid/strap) or a GitHub organization |
| 21 | + - type: dropdown |
| 22 | + attributes: |
| 23 | + label: Code and Assets |
| 24 | + 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 |
| 25 | + options: |
| 26 | + - Yes, all created by my team |
| 27 | + - No, created by other teams |
| 28 | + - type: dropdown |
| 29 | + attributes: |
| 30 | + label: Data |
| 31 | + 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 |
| 32 | + options: |
| 33 | + - Yes, telemetry |
| 34 | + - No. |
| 35 | + - type: dropdown |
| 36 | + attributes: |
| 37 | + label: Cryptography |
| 38 | + description: Does the project implement cryptography? If yes, open an issue in `github/oss-legal-review` and link to that issue in this issue |
| 39 | + options: |
| 40 | + - Yes, implements cryptography |
| 41 | + - No. |
| 42 | + - type: dropdown |
| 43 | + attributes: |
| 44 | + label: Project License |
| 45 | + 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 `legal` and link to that issue in this issue |
| 46 | + options: |
| 47 | + - MIT License |
| 48 | + - Other |
| 49 | + - type: input |
| 50 | + attributes: |
| 51 | + label: Repo URL |
| 52 | + description: Provide the link to the repo URL |
| 53 | + placeholder: https://github.com/github/project-name |
| 54 | + - type: textarea |
| 55 | + attributes: |
| 56 | + label: Project description |
| 57 | + description: Describe the primary use cases for this project - what problem does it solve for users, and why do existing solutions not work? |
| 58 | + value: | |
| 59 | + ... |
| 60 | + - type: textarea |
| 61 | + attributes: |
| 62 | + label: Business implications |
| 63 | + description: Does the project overlap with existing projects or paid products in GitHub or Microsoft's portfolio? If so, what distinguishes it from them, to avoid a situation where we're competing with ourselves? |
| 64 | + value: | |
| 65 | + ... |
| 66 | + - type: input |
| 67 | + attributes: |
| 68 | + label: Community/marketing support |
| 69 | + description: Do you expect a large community of contributors on the project? Is it something that would be beneficial for GitHub to promote through community/marketing channels? |
| 70 | + placeholder: ... |
| 71 | + - type: input |
| 72 | + attributes: |
| 73 | + label: Owning Team |
| 74 | + description: "Name of the team that will own/maintain the project." |
| 75 | + placeholder: "@github/teamname" |
| 76 | + - type: checkboxes |
| 77 | + attributes: |
| 78 | + label: Prepare Project |
| 79 | + options: |
| 80 | + - label: Review and address items in the [release guidelines](https://github.com/github/open-source-releases/blob/main/releasing.md) |
| 81 | + - label: Add `employees` to the repo with at read permission. |
| 82 | + - label: Ensure the repo has a meaningful description, tags, release, packages, and link when applicable |
| 83 | + - label: Consult the product manager(s) of any GitHub products that the open source release may interact with or overlap with by tagging them in this issue. To find who the product owner for a given product might be, check out service catalog |
| 84 | + - label: Remove sensitive materials in the revision history, issues, or pull requests |
| 85 | + - label: "Add LICENSE file (preferred: [MIT LICENSE](https://github.com/github/open-source-releases/blob/main/templates/LICENSE.txt))" |
| 86 | + - label: Update README.md to include sections seen in [`README.md`](https://github.com/github/open-source-releases/blob/main/templates/README.md) |
| 87 | + - label: Add and update [`CODEOWNERS`](https://github.com/github/open-source-releases/blob/main/templates/CODEOWNERS) to list maintainers |
| 88 | + - 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)) |
| 89 | + - label: Add and update [SUPPORT.md](https://github.com/github/open-source-releases/blob/main/templates/SUPPORT.md) |
| 90 | + - label: Add [`CODE_OF_CONDUCT.md`](https://github.com/github/open-source-releases/blob/main/templates/CODE_OF_CONDUCT.md) |
| 91 | + - label: Add [SECURITY.md](https://github.com/github/open-source-releases/blob/main/templates/SECURITY.md) |
| 92 | + - label: "Add branch protection rules to secure how branches are used. Examples: Require a pull request before merging; Require approvals on pull requests;" |
| 93 | + - type: checkboxes |
| 94 | + attributes: |
| 95 | + label: Support |
| 96 | + options: |
| 97 | + - label: Define ownership by creating a Service Catalog entry. If you have questions, start at the FAQ for establishing ownership for open source repositories. |
| 98 | + - label: Follow [best practices for maintainers](https://opensource.guide/best-practices/) |
| 99 | + - label: Join the GitHub maintainer community in discussions. |
| 100 | + - type: checkboxes |
| 101 | + attributes: |
| 102 | + label: Ship It |
| 103 | + options: |
| 104 | + - 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. |
| 105 | + - label: Publish your project! |
| 106 | + - label: Share your project! Post in `internal channels`, on your personal social channels, and the [GitHub blog](https://github.blog/). |
| 107 | + - label: (optional) Give feedback on this process. |
0 commit comments