[
https://issues.apache.org/jira/browse/LUCENE-10184?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17429704#comment-17429704
]
Tomoko Uchida commented on LUCENE-10184:
----------------------------------------
Also, top-level README's "Building with Gradle" could be integrated into the
contribution guide. This section is written for new contributors anyway.
> Move "how to contribute" documentation to the git repo
> ------------------------------------------------------
>
> Key: LUCENE-10184
> URL: https://issues.apache.org/jira/browse/LUCENE-10184
> Project: Lucene - Core
> Issue Type: Task
> Components: general/website
> Reporter: Tomoko Uchida
> Priority: Trivial
>
> This "HowToContrribute" guide in Confluence is well organized and helpful
> (especially for new devs who don't belong to organizations having rich
> practice to contribute to Lucene).
> [https://cwiki.apache.org/confluence/display/lucene/HowToContribute]
> I think it would be great if we have this in the top-level folder as
> "CONTRIBUTING.md" (the file name and place is a common practice on GitHub),
> so that it is more reachable from outside developers.
> https://github.com/github/docs/blob/main/CONTRIBUTING.md
> By having this as Markdown format, it would also be possible to integrate the
> guide into our general documentation with flexmark.
> [https://github.com/apache/lucene/blob/main/gradle/documentation/markdown.gradle]
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
