+1 I think it would be great to have the information in the repo itself, and the CONTRIBUTING file is definitely a standard way of doing this nowadays. And agreed, it can be a top-level document linking to different pages in the dev-docs folder, to give a good structure to the info.
- Houston On Wed, Oct 6, 2021 at 9:50 AM Cassandra Targett <[email protected]> wrote: > I have long wanted to spend some time converting the HowToContribute wiki > page to something in the dev-docs directory. I totally forgot about the > CONTRIBUTING file - if that’s a common way of doing this, then I think we > should do it, and move a good chunk of the HowTo info the dev-docs if we > can. > On Oct 6, 2021, 6:50 AM -0500, 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] > >
