Giter Club home page Giter Club logo

project-template's Introduction

CNCF Project Template Repository

This is a template repository for CNCF projects created by CNCF SIG Contributor Strategy. You can use it to either start a new repository that has all the required files for a CNCF project or just grab the particular files that you need.

Steps

  1. Click Use this template and create a copy of this repository.

    Green button that says "Use this template"

  2. Remove .github/settings.yml. This is not a template and contains configuration specific our repository. You should not keep this file.

  3. Customize every required template and address each TODO item.

Customize Templates

Each file is a template with instructions to customize the contents for your project. Most files use comments with TODO to call out where you need to make changes. We recommend viewing the files in raw or text form so that you can see the comments.

For example in markdown files, we use <!-- TODO: ... --> to provide additional guidance or indicate where action is required but you won't see those comments when you view the markdown file in GitHub unless you view the raw text.

Required Templates

Note: This is the README file for the templates repo. Please use README-template.md as a template for your project README.

project-template's People

Contributors

caniszczyk avatar carolynvs avatar geekygirldawn avatar idvoretskyi avatar jberkus avatar leogr avatar rainbowmango avatar terryhowe avatar xmulligan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

project-template's Issues

Add "Governance Amendments" section to federated project template

Currently, the federated template does not contain a section for how the governance document should be updated. @jberkus fyi.

Operator Framework is currently using this template

Below is a draft to share what I have in mind, it is a WIP PR. Following the Operator Framework governance merge (and the language below settles), I'd be happy to open a PR here. Suggestions welcome :)

## Governance Amendments

The Operator Framework Community may adopt or amend its Governing
Documents according to the following process:

1. Propose a change by opening an issue in the community repository, and if there
   seems to be general agreement, open a pull request to this document.
2. The change should be announced via the mailing list along with an invitation for discussion on the Pull Request.
3. A minimum of 7 days must pass between the announcement and the vote. If there is not consensus, the Steering Committee is encouraged to delay the vote. The Steering Committee can pass the amendment with a 2/3 majority and a minimum quorum of 1/2 of the Committee.

Should we add MADR to project template?

We noticed that users and contributors of cloud native projects care a lot about why a certain technical decision was taken.

In our Kubernetes distribution, we use Markdown Any Decision Records. In essence, you create a folder docs/adr with a file template.md. Then you copy the template for each decision you take. Here is an example on how this would look like.

Would it be beneficial to include this in the CNCF project template?

Add sample OWNERS file to repository

There is broken link reference to an OWNERS file in https://github.com/cncf/project-template/blob/main/GOVERNANCE-maintainer.md:

[TODO: PROJECTNAME] Maintainers have write access to the [project GitHub repository](TODO).
They can merge their own patches or patches from others. The current maintainers
can be found in [OWNERS](./OWNERS).  Maintainers collectively manage the project's
resources and contributors.

However, I do not see an OWNERS file in the cncf/project-template repository. Would it be possible to provide a sample OWNERS file? From what I've seen, I think the file is just the GitHub usernames of the owners? If it doesn't make sense to add a sample OWNERS file, perhaps removing the broken link to the file in the GOVERNANCE-maintainer.md would be less confusing.

Permissions to merge PRs in this repo

I'm not sure who has permission to merge PRs in this repo, so I keep pinging @amye to merge things. Would it be possible for @jberkus and I to get the permissions required to merge PRs?

I promise that we won't merge anything unless we have TOC liaison approval, but allowing us to merge would reduce the load for Amye and the TOC :)

cc: @TheFoxAtWork & @dzolotusky

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.