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

Achieve contribution workflow perfection (with progress)

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • None
    • None
    • New

    Description

      Inspired by Dawid's build issue which has worked out for us: LUCENE-9871
      He hasn't even linked 10% of the issues/subtasks involved in that work either, but we know.

      I think we need a similar approach for the contribution workflow. There has been some major improvements recently, a couple that come to mind:

      • Tomoko made a CONTRIBUTING.md file which github recognizes and is way better than the wiki stuff
      • Some hazards/error messages/mazes in the build process and so on have gotten fixed.

      But there is more to do in my opinion, here is 3 ideas:

      • Creating a PR still has a massive checklist template. But now this template links to CONTRIBUTING.md, so why include the other stuff/checklist? Isn't it enough to just link to CONTRIBUTING.md and fix that as needed?
      • Creating a PR still requires signing up for Apache JIRA and creating a JIRA issue. There is zero value to this additional process. We often end out with either JIRAs and/or PRs that have zero content, or maybe conflicting/outdated content. This is just an unnecessary dance, can we use github issues instead?
      • Haven't dug into the github actions or configs very deeply. Maybe there's simple stuff we can do such as give useful notifications if checks fail. Try to guide the user to run ./gradlew check and fix it. It sucks to have to review, look at logs, and manually add comments to do this stuff.

      So let's have an issue to improve this area.

      Attachments

        Activity

          People

            Unassigned Unassigned
            rcmuir Robert Muir
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 3h
                3h