+1 It is really crucial for newbies! On 7 Oct 2021 Thu at 16:00 David Smiley <[email protected]> wrote:
> +1 Fantastic idea > > ~ David Smiley > Apache Lucene/Solr Search Developer > http://www.linkedin.com/in/davidwsmiley > > > On Wed, Oct 6, 2021 at 7:50 AM Jan Høydahl <[email protected]> wrote: > >> Hi, >> >> Should we consider adding a CONTRIBUTING(.md) file to the solr git repo? >> >> Currently we have our wiki page >> https://cwiki.apache.org/confluence/display/SOLR/HowToContribute which >> is linked from README.md. >> But there has been complaints lately that this wiki page is old and >> needlessly complex / long. >> >> Some benefits of a CONTRIBUTING file are: >> * People immediately understand what to expect when they see the file >> (visibility) >> * GitHub has built-in support for it and will display a link when someone >> opens a PR ( >> https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors >> ) >> * We can author it from scratch, with better, clearer structure >> >> The file can of course rely on linking to dev-docs, wiki and website as >> needed, so the file can likely stay quite compact. >> >> Jan >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> >>
