You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "Tomoko Uchida (Jira)" <ji...@apache.org> on 2022/04/04 10:09:00 UTC
[jira] [Commented] (LUCENE-10184) Move "how to contribute" documentation to the git repo
[ https://issues.apache.org/jira/browse/LUCENE-10184?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17516722#comment-17516722 ]
Tomoko Uchida commented on LUCENE-10184:
----------------------------------------
I opened a follow-up PR to optionally request opening a Jira issue. It's obvious for committers but could be an unfamiliar convention for outside contributors; would it be good to have a mention of it - for careful contributors who read the guide?
https://github.com/apache/lucene/pull/781
> 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
> Time Spent: 2h 20m
> Remaining Estimate: 0h
>
> 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.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org