From patchwork Mon Oct 16 23:29:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Gallager X-Patchwork-Id: 153819 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2908:b0:403:3b70:6f57 with SMTP id ib8csp3790485vqb; Mon, 16 Oct 2023 16:39:29 -0700 (PDT) X-Google-Smtp-Source: AGHT+IE+RZfaK1inAQMMMgC10YhRvxofCzPggxDjs2fKliOO1mjV4WNqh8YyjcTpVPh/o3CxeTlS X-Received: by 2002:ad4:4f29:0:b0:63d:580:9c68 with SMTP id fc9-20020ad44f29000000b0063d05809c68mr311328qvb.32.1697499568891; Mon, 16 Oct 2023 16:39:28 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1697499568; cv=pass; d=google.com; s=arc-20160816; b=C0qitn9kM2nTWlHRwLWurtuGVnI7DgqrbdwzY2ERUkO1P3ZEZTIqXiPUhj2i87ibUZ 5HCTljt9VXnaR/PNTPFYQ4u6oWRjW09t5Yq6wGLfpIVYSoJ0n1DiHk748woAjjFiR+Ed Fz5x6Y+3pbNHc/64MTHBVSpV1G+jxEYXH+odkRpW9rU8mGIxUsyEVGJ2wNV/V0BWLoyd jvyQU88TmXG8u0KUTgs9wTACFHJPtocegI4fmhvU/0TflZoAw5owU8bfWupofNGnnCpF XVxeVjljlvMuJwE88nLov8hfTGqWFuoLttVmhiXvBk2VguriA74e+MfVsOsPexXuzZLS iO2A== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:arc-filter :dmarc-filter:delivered-to:dkim-signature:dkim-filter; bh=sbn8su2G+XLyCNgGSJ/b7klCwNc+9G3IO+1wFp/n39k=; fh=9XsDbqiJTcWIE+R3EYxsUPZI2m4fCz5urOIxyNuqi9o=; b=cmMGaSxjCJB6CHsJyvml8NgjeKgTRkfTXgEvHeT+WmAvfUPEmqmutPUDtZ3byfYZi6 ldmoJM0xSdLlSAZr2IWZdIcDM+JacIxoPwNVnLXNOKTV0WyeP06X9AD4Gi6oLCVZyURs jZmjQ4smFrZtJMLW3w//gKuVk8KkgT307zUaS/u5eF0F9Rd5NHiHvq9jlKFkXHbrsdGA KZOP8UX4LWmv6084/jCK63k0SgLbaDmJkG9iObr6oKdDUPy6SxqaB+x/iBbIUHnJSGUK VOZHiYZ7OP9bXHu114gtjfGu2/gi46XlplAUMTBIH6fzQhT1jQshEeegnTesA1tLAPMc pKCQ== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=ppbaBGxV; arc=pass (i=1); spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from server2.sourceware.org (server2.sourceware.org. [2620:52:3:1:0:246e:9693:128c]) by mx.google.com with ESMTPS id j13-20020a05620a288d00b0077701e9f740si251572qkp.775.2023.10.16.16.39.28 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 Oct 2023 16:39:28 -0700 (PDT) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) client-ip=2620:52:3:1:0:246e:9693:128c; Authentication-Results: mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=ppbaBGxV; arc=pass (i=1); spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 928D83858438 for ; Mon, 16 Oct 2023 23:39:28 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 928D83858438 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1697499568; bh=sbn8su2G+XLyCNgGSJ/b7klCwNc+9G3IO+1wFp/n39k=; h=From:To:Cc:Subject:Date:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From; b=ppbaBGxVaYY3PBz0oEUeiXmEYCYY6muDOmDF9m60XVCn9PM2+5dXNmI2C6yIRBrCv FsM2NYuZZHXbU1PPwRwBVxW8K1E2QkVFkIpafC41eaaLpOoG53y1o4UZR8sO/q2nfJ 3M26Mm0Vbk7+iF5MTEVUBC/awSKM5eWCWGma5E3k= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from Local-Admins-MacBook-Pro.local (unknown [72.65.124.79]) by sourceware.org (Postfix) with ESMTP id BDF5C3858D33; Mon, 16 Oct 2023 23:38:43 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org BDF5C3858D33 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=gcc.gnu.org Authentication-Results: sourceware.org; spf=fail smtp.mailfrom=gcc.gnu.org ARC-Filter: OpenARC Filter v1.0.0 sourceware.org BDF5C3858D33 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=72.65.124.79 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1697499526; cv=none; b=TSHO+E1JzTHAHcFMgLSI7Ab43OnikwIiAYrU1ZevLJTEj1uWovuHazD0M4YL/uRmmlG7gOZwX+pBVEllW1ggNj5+QU3PEU+paJ5V+gZNSIMJAwCds3KVRuYKpPBOrvTEkGpemJ55FaE3U7CQ8oCInhpSjw3ayI4LiuUPd5Z0tGk= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1697499526; c=relaxed/simple; bh=0lDnXJv9QU5tlj3QlbAKskEl7UXD53rNWW9OWTaryuE=; h=From:To:Subject:Date:Message-Id:MIME-Version; b=MM9njwijwZNT5TY336icIMoryc+FTPEuCuJCAd3F0zmlLIMNJNQ79Ks6BdFMg+TkMC19/y8pwyjDOgs0U7Epwx/O3Ro0wAZmZgWD4AF28cafldiVrOYLiM5rKoU9LFcP8/Bq1A0HJwpSShhZ+iQsgbt0pwo/2NP6WfMCNoK8awM= ARC-Authentication-Results: i=1; server2.sourceware.org Received: by Local-Admins-MacBook-Pro.local (Postfix, from userid 501) id A9EF632CD12C5; Mon, 16 Oct 2023 19:38:16 -0400 (EDT) From: Eric Gallager To: gcc-patches@gcc.gnu.org Cc: Eric Gallager Subject: [PATCH] Add files to discourage submissions of PRs to the GitHub mirror. Date: Mon, 16 Oct 2023 19:29:40 -0400 Message-Id: <20231016232939.91393-1-egallager@gcc.gnu.org> X-Mailer: git-send-email 2.32.0 (Apple Git-132) MIME-Version: 1.0 X-Spam-Status: No, score=-6.4 required=5.0 tests=BAYES_00, GIT_PATCH_0, JMQ_SPF_NEUTRAL, KAM_DMARC_STATUS, KAM_SHORT, KHOP_HELO_FCRDNS, RCVD_IN_PBL, RCVD_IN_SORBS_DUL, RDNS_DYNAMIC, SPF_HELO_NONE, SPF_NEUTRAL, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779957308009205941 X-GMAIL-MSGID: 1779957308009205941 Currently there is an unofficial mirror of GCC on GitHub that people sometimes submit pull requests to: https://github.com/gcc-mirror/gcc However, this is not the proper way to contribute to GCC, so that means that someone (usually Jonathan Wakely) has to go through the PRs and manually tell people that they're sending their PRs to the wrong place. One thing that would help mitigate this problem would be files in a special .github directory that GitHub would automatically open when contributors attempt to open a PR, that would then tell them the proper way to contribute instead. This patch attempts to add two such files. They are written in Markdown, which I'm realizing might require some special handling in this repository, since the ".md" extension is also used for GCC's "Machine Description" files here, but I'm not quite sure how to go about handling that. Also note that I adapted these files from equivalent files in the git repository for Git itself: https://github.com/git/git/blob/master/.github/CONTRIBUTING.md https://github.com/git/git/blob/master/.github/PULL_REQUEST_TEMPLATE.md What do people think? ChangeLog: * .github/CONTRIBUTING.md: New file. * .github/PULL_REQUEST_TEMPLATE.md: New file. --- .github/CONTRIBUTING.md | 18 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 2 files changed, 23 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000000..4f7b3abca5f4 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Contributing to GCC + +Thanks for taking the time to contribute to GCC! Please be advised that if you are +viewing this on `github.com`, that the mirror there is unofficial and unmonitored. +The GCC community does not use `github.com` for their contributions. Instead, we use +a mailing list (`gcc-patches@gcc.gnu.org`) for code submissions, code +reviews, and bug reports. + +Perhaps one day it will be possible to use [GitGitGadget](https://gitgitgadget.github.io/) to +conveniently send Pull Requests commits to GCC's mailing list, the way that the Git project currently allows it to be used to send PRs to their mailing list, but until that day arrives, please send your patches to the mailing list manually. + +Please read ["Contributing to GCC"](https://gcc.gnu.org/contribute.html) on the main GCC website +to learn how the GCC project is managed, and how you can work with it. +In addition, we highly recommend you to read [our guidelines for read-write Git access](https://gcc.gnu.org/gitwrite.html). + +Or, you can follow the ["Contributing to GCC in 10 easy steps"](https://gcc.gnu.org/wiki/GettingStarted#Basics:_Contributing_to_GCC_in_10_easy_steps) section of the ["Getting Started" page](https://gcc.gnu.org/wiki/GettingStarted) on [the wiki](https://gcc.gnu.org/wiki) for another example of the contribution process. + +Your friendly GCC community! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..6417392c8cf3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +Thanks for taking the time to contribute to GCC! Please be advised that if you are +viewing this on `github.com`, that the mirror there is unofficial and unmonitored. +The GCC community does not use `github.com` for their contributions. Instead, we use +a mailing list (`gcc-patches@gcc.gnu.org`) for code submissions, code reviews, and +bug reports. Please send patches there instead.