[ 
https://issues.apache.org/jira/browse/SOLR-16544?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17633377#comment-17633377
 ] 

Jan Høydahl commented on SOLR-16544:
------------------------------------

This Jira duplicates SOLR-16121 and SOLR-15682. There the proposal is to add a 
top-level CONTRIBUTING.md, which is natively understood by GitHub.

See comments in those issues for backround. 

I'd prefer a light-weight CONTRIBUTING.md file, with links into details on each 
topic (git/branches, gradle, PRs etc)

> Improve documentation on "How to Contribute"
> --------------------------------------------
>
>                 Key: SOLR-16544
>                 URL: https://issues.apache.org/jira/browse/SOLR-16544
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Justin Sweeney
>            Priority: Minor
>
> Currently the main location for information on how to contribute to the Solr 
> open source project is here: 
> [https://cwiki.apache.org/confluence/display/solr/HowToContribute.|https://cwiki.apache.org/confluence/display/solr/HowToContribute]
>  As colleagues I work with are increasing our contributions to the Solr 
> community, we found this documentation difficult to parse and it seems like 
> it could use some love.
> My idea is to write up the current best practices for contributing within the 
> dev-docs README in Github: 
> [https://github.com/apache/solr/blob/main/dev-docs/README.adoc] and link to 
> that from the Solr reference docs to make it more easily findable. This will 
> provide the information for how to contribute in a version controlled 
> location, making updates easier in the future as well. 



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

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to