[pgpool-hackers: 3431] Re: [PATCH] Add CONTRIBUTING file
Alejandro Roman
alejandro at aromnn.com
Fri Sep 13 15:50:33 JST 2019
On Fri, Sep 13, 2019 at 02:27:46PM +0900, Tatsuo Ishii wrote:
> > I agree with you about the maintance headache if we keep two identical
> > contents. I think this CONTRIBUTING file could go into the `Preface`
> > section of the docs, between the "Further information" and "Restrictions"
> > headers, perhaps under the title of "Contributing".
> >
> > Also, I noticed that some information given in the CONTRIBUTING file is
> > already present in the docs, specifically the "Bugs" and "Our channels"
> > sections of the file. For this reason, I think these two sections could be
> > removed from the "Contributing" page.
> >
> > On the other hand, if the contents of the CONTRIBUTING file get moved to
> > the docs, I still think that a CONTRIBUTING file should be kept in the
> > source tree. This is because it is a convention in open source projects
> > to have that file and it will probably be looked for by new
> > contributors. This CONTRIBUTING file could only have a message and a
> > link to the "Contributing" page at the docs.
>
> All agreed.
>
> > By the way, considering the problem with double contents, I found the TODO
> > file in the source tree and the TODO from wiki page confussing when I was
> > figuring out how to contribute to the project. Considering also that the
> > TODO file hasn't been updated since 2011 (at least in the master
> > branch), what would you say if we delete it's content and put a
> > reference to the TODO wiki page instead?
>
> Again I agree. The TODO file has not been maintained for a while. I
> think we could focus on the TODO wiki page and put only link in the
> TODO file in the source tree as you suggested.
>
> Best regards,
> --
> Tatsuo Ishii
> SRA OSS, Inc. Japan
> English: http://www.sraoss.co.jp/index_en.php
> Japanese:http://www.sraoss.co.jp
Alright. I will prepare the patches for the changes.
Alejandro
More information about the pgpool-hackers
mailing list