diff mbox series

Add files to discourage submissions of PRs to the GitHub mirror.

Message ID 20231016232939.91393-1-egallager@gcc.gnu.org
State Accepted
Headers
Series Add files to discourage submissions of PRs to the GitHub mirror. |

Checks

Context Check Description
snail/gcc-patch-check success Github commit url

Commit Message

Eric Gallager Oct. 16, 2023, 11:29 p.m. UTC 
  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

Comments

Andrew Pinski Oct. 16, 2023, 11:58 p.m. UTC | #1 
On Mon, Oct 16, 2023, 16:39 Eric Gallager <egallager@gcc.gnu.org> wrote:

> 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?
>


I think this is a great idea. Is a similar one for opening issues too?

Thanks,
Andrew


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.
>
Eric Gallager Oct. 17, 2023, 12:50 a.m. UTC | #2 
On Mon, Oct 16, 2023 at 7:58 PM Andrew Pinski <pinskia@gmail.com> wrote:
>
>
>
> On Mon, Oct 16, 2023, 16:39 Eric Gallager <egallager@gcc.gnu.org> wrote:
>>
>> 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?
>
>
>
> I think this is a great idea. Is a similar one for opening issues too?
>

One for issues isn't necessary, because the GitHub mirror has never
had issues enabled in the first place, so people already can't open
issues there.

> Thanks,
> Andrew
>
>
>> 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.
Eric Gallager Nov. 1, 2023, 2:11 p.m. UTC | #3 
Hi, I'd like to ping the following patch:

https://gcc.gnu.org/pipermail/gcc-patches/2023-October/633191.html

On Mon, Oct 16, 2023 at 8:50 PM Eric Gallager <egall@gwmail.gwu.edu> wrote:
>
> On Mon, Oct 16, 2023 at 7:58 PM Andrew Pinski <pinskia@gmail.com> wrote:
> >
> > On Mon, Oct 16, 2023, 16:39 Eric Gallager <egallager@gcc.gnu.org> wrote:
> >>
> >> 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?
> >
> >
> >
> > I think this is a great idea. Is a similar one for opening issues too?
> >
>
> One for issues isn't necessary, because the GitHub mirror has never
> had issues enabled in the first place, so people already can't open
> issues there.
>
> > Thanks,
> > Andrew
> >
> >
> >> 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.
Jeff Law Nov. 1, 2023, 3:30 p.m. UTC | #4 
On 11/1/23 08:11, Eric Gallager wrote:
> Hi, I'd like to ping the following patch:
> 
> https://gcc.gnu.org/pipermail/gcc-patches/2023-October/633191.html
OK for the trunk.

jeff
Eric Gallager Nov. 1, 2023, 11:25 p.m. UTC | #5 
On Wed, Nov 1, 2023 at 11:31 AM Jeff Law <jeffreyalaw@gmail.com> wrote:
>
>
>
> On 11/1/23 08:11, Eric Gallager wrote:
> > Hi, I'd like to ping the following patch:
> >
> > https://gcc.gnu.org/pipermail/gcc-patches/2023-October/633191.html
> OK for the trunk.
>

Thanks, committed as r14-5064-g2b9778c8d9d331:
https://gcc.gnu.org/git/?p=gcc.git;a=commitdiff;h=2b9778c8d9d33174de63716b74b2f114d700e104

> jeff
Eric Gallager Nov. 1, 2023, 11:31 p.m. UTC | #6 
On Wed, Nov 1, 2023 at 7:25 PM Eric Gallager <egall@gwmail.gwu.edu> wrote:
>
> On Wed, Nov 1, 2023 at 11:31 AM Jeff Law <jeffreyalaw@gmail.com> wrote:
> >
> >
> >
> > On 11/1/23 08:11, Eric Gallager wrote:
> > > Hi, I'd like to ping the following patch:
> > >
> > > https://gcc.gnu.org/pipermail/gcc-patches/2023-October/633191.html
> > OK for the trunk.
> >
>
> Thanks, committed as r14-5064-g2b9778c8d9d331:
> https://gcc.gnu.org/git/?p=gcc.git;a=commitdiff;h=2b9778c8d9d33174de63716b74b2f114d700e104

...and then I cleaned up the formatting a bit in
r14-5065-g4968e4844a3ce3, which I pushed under the "obvious" rule:
https://gcc.gnu.org/git/?p=gcc.git;a=commitdiff;h=4968e4844a3ce30143ae2e267895c418f5c636a1

>
> > jeff
diff mbox series

Patch

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.