Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-10184

Move "how to contribute" documentation to the git repo

    XMLWordPrintableJSON

Details

    • Task
    • Status: Resolved
    • Trivial
    • Resolution: Fixed
    • None
    • None
    • general/website
    • None
    • New

    Description

      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

      Attachments

        Activity

          People

            Unassigned Unassigned
            tomoko Tomoko Uchida
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 2h 40m
                2h 40m