Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project contribution issue template #230

Closed
wants to merge 19 commits into from
187 changes: 187 additions & 0 deletions .github/ISSUE_TEMPLATE/project_contribution_incubate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
name: Incubating Project Contribution
description: Contribution a Project to the OpenSSF
title: "[Project Contribution Incubating]: "
labels: ["administration", "For Review"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Project Contribution!
- type: markdown
attributes:
value: "Incubating projects represent maturing but not fully realized projects. Incubating projects have an established technical vision and working project, but are still refining implementation, discovering (and adapting to) new use cases, and operating as an open source team."
- type: markdown
attributes:
value: "Projects must have a minimum of three maintainers with a minimum of two different organization affiliations, and document the current list of maintainers."
- type: input
id: Maintainer-1-Name
attributes:
label: First Maintainer's Name
placeholder: Name
validations:
required: true
- type: input
id: Maintainer-1-GitHub
attributes:
label: First Maintainer's Name
placeholder: GitHub-Id
validations:
required: true
- type: input
id: Maintainer-1-Company
attributes:
label: First Maintainer's Company
placeholder: Company
validations:
required: true
- type: input
id: Maintainer-2-Name
attributes:
label: Second Maintainer's Name
placeholder: Name
validations:
required: true
- type: input
id: Maintainer-2-GitHub
attributes:
label: Second Maintainer's Name
placeholder: GitHub-Id
validations:
required: true
- type: input
id: Maintainer-2-Company
attributes:
label: Second Maintainer's Company
placeholder: Company
validations:
required: true
- type: input
id: Maintainer-3-Name
attributes:
label: Third Maintainer's Name
placeholder: Name
validations:
required: true
- type: input
id: Maintainer-3-GitHub
attributes:
label: Third Maintainer's Name
placeholder: GitHub-Id
validations:
required: true
- type: input
id: Maintainer-3-Company
attributes:
label: Third Maintainer's Company
placeholder: Company
validations:
required: true
- type: textarea
id: Maintainers-other
attributes:
label: List any other maintainers in this format
placeholder: Name GitHub Company
validations:
required: false
- type: input
id: contributor-guide
attributes:
label: Where is you contributor guide?
description: "Projects must have defined a contributor guide, which makes it clear how and when contributors should be given increasing responsibilities towards maintainership of the project. (Example guides: [Sigstore](https://github.com/sigstore/community/blob/main/MEMBERSHIP.md), [AllStar](https://github.com/ossf/allstar/blob/main/contributor-ladder.md))"
value: "link"
validations:
required: true
- type: textarea
id: usage
attributes:
label: Where is your project already being used?
description: "Projects should be able to show adoption by multiple parties and adoption's value to the open source community and/or end users (may include adoption of beta/early versions) with the intent to showcase wide adoption by the project's consumers."
value: "eg. website, repo, testimonial, landscape, email"
validations:
required: true
- type: textarea
id: mission
attributes:
label: What is your Project Mission?
description: "Projects must be aligned with the OpenSSF mission and either be a novel approach for existing areas or address an unfulfilled need. It is expected that the initial code or specification developed by an OpenSSF WG be kept within their repository and will not function as a Project in its own right. Should the initial WG code or specification grow and mature that it warrants its own Project status, then it is subject to Sandbox entry requirements. It is preferred that extensions of an existing OpenSSF project collaborate with the existing project rather than seek a new project."
value: "The mission of the Project is to "
validations:
required: true
- type: input
id: governance
attributes:
label: Where is your project governence documented?

Check failure on line 113 in .github/ISSUE_TEMPLATE/project_contribution_incubate.yaml

View workflow job for this annotation

GitHub Actions / Check Spelling

`governence` is not a recognized word. (unrecognized-spelling)
description: "Projects must have documented, initial project governance."
value: "link"
validations:
required: true
- type: markdown
attributes:
value: "A maintainer of the project(s) should create a [PR in this repository](https://github.com/ossf/tac/pulls) with a new file with [project-lifecycle-documents directory](https://github.com/ossf/tac/tree/project_contribution_template/process/project-lifecycle-documents) containing all information requested for a project creation. This file must be based on the [template for the respective lifecycle stage in the templates directory](https://github.com/ossf/tac/tree/project_contribution_template/process/templates). The `PROJECT_NAME_` prefix of the template must be replaced by the project name."
- type: input
id: PR-project-lifecycle
attributes:
label: What is the link to the above PR?
validations:
required: true
- type: markdown
attributes:
value: "The above PR you should also have made a modification of the table listing all projects in the README of this repository by adding the project(s) to the table."
- type: dropdown
id: PR-table-addition
attributes:
label: Does your PR also have the modified table?
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: "Contributing an existing project to the OpenSSF requires a one-time IP policy and license review with The Linux Foundation."
- type: dropdown
id: IP-Review
attributes:
label: Do you need such a review?
options:
- "Yes"
- "No"
validations:
required: true
- type: textarea
attributes:
label: OpenSSF Overlap
description: What OpenSSF projects does this project overlap with, and how?
validations:
required: false
- type: textarea
attributes:
label: Similarities projects
description: Please list similar projects in the OpenSSF or elsewhere.
validations:
required: false
- type: textarea
attributes:
label: Project champions
description: Please list any people who are part of OpenSSF leadership (TAC, GB, etc.) who can endorse or answer questions about your project.
validations:
required: false
- type: textarea
id: Anything-else
attributes:
label: Additional information
description: Any additional information you would like the TAC to consider when evaluating this project?
value:
validations:
required: false
- type: markdown
attributes:
value: "Thanks for completing this form to contribute your project! If you have any problems, questions or concerns please email us at [email protected]"
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [OpenSSF Code of Conduct](https://openssf.org/community/code-of-conduct/)
options:
- label: I agree to follow the OpenSSF's Code of Conduct
required: true
139 changes: 139 additions & 0 deletions .github/ISSUE_TEMPLATE/project_contribution_sandbox.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
name: Sandbox Project Contribution
description: Contribution a Project to the OpenSSF
title: "[Project Contribution Sandbox]: "
labels: ["administration","For Review"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Sandbox Project Contribution!
- type: markdown
attributes:
value: "Sandbox Projects must have a minimum of two maintainers with different organization affiliations."
- type: input
id: Maintainer-1-Name
attributes:
label: First Maintainer's Name
placeholder: Name
validations:
required: true
- type: input
id: Maintainer-1-GitHub
attributes:
label: First Maintainer's Name
placeholder: GitHub-Id
validations:
required: true
- type: input
id: Maintainer-1-Company
attributes:
label: First Maintainer's Company
placeholder: Company
validations:
required: true
- type: input
id: Maintainer-2-Name
attributes:
label: Second Maintainer's Name
placeholder: Name
validations:
required: true
- type: input
id: Maintainer-2-GitHub
attributes:
label: Second Maintainer's Name
placeholder: GitHub-Id
validations:
required: true
- type: input
id: Maintainer-2-Company
attributes:
label: Second Maintainer's Company
placeholder: Company
validations:
required: true
- type: textarea
id: Maintainers-other
attributes:
label: List any other maintainers in this format
placeholder: Name GitHub Company
validations:
required: false
- type: textarea
id: mission
attributes:
label: What is your Project Mission?
description: "Projects must be aligned with the OpenSSF mission and either be a novel approach for existing areas or address an unfulfilled need. It is expected that the initial code or specification developed by an OpenSSF WG be kept within their repository and will not function as a Project in its own right. Should the initial WG code or specification grow and mature that it warrants its own Project status, then it is subject to Sandbox entry requirements. It is preferred that extensions of an existing OpenSSF project collaborate with the existing project rather than seek a new project."
value: "The mission of the Project is to "
validations:
required: true
- type: markdown
attributes:
value: "A maintainer of the project(s) should create a [PR in this repository](https://github.com/ossf/tac/pulls) with a new file with [project-lifecycle-documents directory](https://github.com/ossf/tac/tree/project_contribution_template/process/project-lifecycle-documents) containing all information requested for a project creation. This file must be based on the [template for the respective lifecycle stage in the templates directory](https://github.com/ossf/tac/tree/project_contribution_template/process/templates). The `PROJECT_NAME_` prefix of the template must be replaced by the project name."
- type: input
id: PR-project-lifecycle
attributes:
label: What is the link to the above PR?
validations:
required: true
- type: markdown
attributes:
value: "The above PR you should also have made a modification of the table listing all projects in the README of this repository by adding the project(s) to the table."
- type: dropdown
id: PR-table-addition
attributes:
label: Does your PR also have the modified table?
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: "Contributing an existing project to the OpenSSF requires a one-time IP policy and license review with The Linux Foundation."
- type: dropdown
id: IP-Review
attributes:
label: Do you need such a review?
options:
- "Yes"
- "No"
validations:
required: true
- type: textarea
attributes:
label: OpenSSF Overlap
description: What OpenSSF projects does this project overlap with, and how?
validations:
required: false
- type: textarea
attributes:
label: Similarities projects
description: Please list similar projects in the OpenSSF or elsewhere.
validations:
required: false
- type: textarea
attributes:
label: Project champions
description: Please list any people who are part of OpenSSF leadership (TAC, GB, etc.) who can endorse or answer questions about your project.
validations:
required: false
- type: textarea
id: Anything-else
attributes:
label: Additional information
description: Any additional information you would like the TAC to consider when evaluating this project?
value:
validations:
required: false
- type: markdown
attributes:
value: "Thanks for completing this form to contribute your project! If you have any problems, questions or concerns please email us at [email protected]"
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [OpenSSF Code of Conduct](https://openssf.org/community/code-of-conduct/)
options:
- label: I agree to follow the OpenSSF's Code of Conduct
required: true
2 changes: 2 additions & 0 deletions .github/actions/spelling/allow.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ Guidewire
GraphQL
Appelquist
torgo
hythloda
checkboxes
Loading