first draft of a written policy around git repos
authorChristian Kühnel <kuhnel@google.com>
Wed, 13 Oct 2021 15:14:57 +0000 (15:14 +0000)
committerChristian Kühnel <kuhnel@google.com>
Tue, 19 Oct 2021 08:05:37 +0000 (08:05 +0000)
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

llvm/docs/GettingInvolved.rst
llvm/docs/GitRepositoryPolicy.md [new file with mode: 0644]

index e051ce1..3f38b6b 100644 (file)
@@ -19,6 +19,7 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
    BugLifeCycle\r
    CodingStandards\r
    GitBisecting\r
+   GitRepositoryPolicy\r
 \r
 :doc:`Contributing`\r
    An overview on how to contribute to LLVM.\r
@@ -54,6 +55,9 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
 :doc:`GitBisecting`\r
   Describes how to use ``git bisect`` on LLVM's repository.\r
 \r
+:doc:`GitRepositoryPolicy`\r
+   Collection of policies around the git repositories.\r
+\r
 .. _development-process:\r
 \r
 Development Process\r
diff --git a/llvm/docs/GitRepositoryPolicy.md b/llvm/docs/GitRepositoryPolicy.md
new file mode 100644 (file)
index 0000000..f6442e4
--- /dev/null
@@ -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.