first draft of a written policy around git repos

This is a frist draft of a set of policies around new git repos and how we grant write access to our GitHub organisation.

This proposal is based on the discussions in:
https://github.com/llvm/llvm-iwg/issues/40
https://github.com/llvm/llvm-iwg/issues/51

Differential Revision: https://reviews.llvm.org/D111723
This commit is contained in:
Christian Kühnel 2021-10-13 15:14:57 +00:00
parent 7272982e1d
commit dcc91dd2a7
2 changed files with 41 additions and 0 deletions

View File

@ -19,6 +19,7 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
BugLifeCycle
CodingStandards
GitBisecting
GitRepositoryPolicy
:doc:`Contributing`
An overview on how to contribute to LLVM.
@ -54,6 +55,9 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
:doc:`GitBisecting`
Describes how to use ``git bisect`` on LLVM's repository.
:doc:`GitRepositoryPolicy`
Collection of policies around the git repositories.
.. _development-process:
Development Process

View File

@ -0,0 +1,37 @@
# Policies on git repositories
This document explains our current policies around git repositories. Everything
not covered in this document is most likely a case-by-case decision. In these
cases please create an issue with the
[Infrastructure Working Group](https://github.com/llvm/llvm-iwg/issues).
## New GitHub repositories
Requirements for *new* repositories as part of the
[LLVM organisation on GitHub](https://github.com/llvm):
* The repo will be used for something related to the LLVM ecosystem or community.
* The repo contains a `README.md` explaining the contents.
* The repo contains a `CONTRIBUTING.md`, ideally copy this from
[llvm-project](https://github.com/llvm/llvm-project/blob/main/CONTRIBUTING.md).
* The repo contains a `LICENSE.TXT`, preferably copy this from
[llvm-project](https://github.com/llvm/llvm-project/blob/main/LICENSE.TXT).
Other licences need to be discussed case-by-case.
If you want to integrate your project as part of the Monorepo, please take a
look at the
[Developer Policy](DeveloperPolicy.html#adding-an-established-project-to-the-llvm-monorepo>).
To request a new repository, please create an issue with the
[Infrastructure Working Group](https://github.com/llvm/llvm-iwg/issues).
## Repo access on GitHub
Some 3rd party applications require write access to our GitHub organisation in
order to work properly. Typical examples are continuous integration services
reporting build results back to GitHub. We consider granting access to such
application if they provide benefits to the LLVM community and do not raise
privacy or security concerns.
To request access please run an RFC on the mailing list and get community
feedback.