apache / apache/lucene

Achieve contribution workflow perfection (with progress) [LUCENE-10543]

Open
#11,579 14 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major type:task
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

Inspired by Dawid's build issue which has worked out for us: #10910
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.

---
Migrated from [LUCENE-10543](https://issues.apache.org/jira/browse/LUCENE-10543) by Robert Muir (@rmuir), updated May 04 2022
Attachments: [Screen_Shot_2022-04-30_at_01.15.00.png](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-10543/Screen_Shot_2022-04-30_at_01.15.00.png)
Sub-tasks:
- #11581
- #11593
- #11658

Contributor guide

Open the contributing guide

Research direction

The issue names CONTRIBUTING.md, the pull-request checklist template, GitHub Actions/configs, and ./gradlew check. Start by reviewing those workflow entry points and the linked sub-tasks to separate the proposed changes. Done requires an agreed contribution process, updated guidance or templates, and useful check-failure instructions.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, github-actions
Domain
ci-cd, developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.