You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "Eric Pugh (Jira)" <ji...@apache.org> on 2023/01/23 22:09:00 UTC

[jira] [Resolved] (SOLR-15682) Add a CONTRIBUTING file

     [ https://issues.apache.org/jira/browse/SOLR-15682?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eric Pugh resolved SOLR-15682.
------------------------------
    Resolution: Duplicate

> Add a CONTRIBUTING file
> -----------------------
>
>                 Key: SOLR-15682
>                 URL: https://issues.apache.org/jira/browse/SOLR-15682
>             Project: Solr
>          Issue Type: Task
>          Components: documentation
>            Reporter: Jan Høydahl
>            Assignee: Eric Pugh
>            Priority: Major
>
> As [discussed in dev-list|https://lists.apache.org/thread.html/raa4a0538fb7b32ebf4ec2d9a26bf04680b001b2723b70633eb06bcb4%40%3Cdev.solr.apache.org%3E], we should add a {{CONTRIBUTING.md}} file to serve as the first introduction for how to contribute:
> {quote}Currently we have our wiki page [HowToContribute|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|https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors] and will display a link when someone opens a PR.
>  * 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.
> {quote}
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org