jamulus icon indicating copy to clipboard operation
jamulus copied to clipboard

Automatically add new contributor to source code

Open ann0see opened this issue 3 years ago • 5 comments

Has this feature been discussed and generally agreed?

Not yet, but related to https://github.com/jamulussoftware/jamulus/pull/2264#issuecomment-1019570820 Describe the solution you'd like

If a new user opens a PR and this PR gets merged, GitHub actions should open a PR based on the Check contributors script (https://github.com/jamulussoftware/jamulus/blob/master/tools/get_release_contributors.py) and add undocumented contributors automatically to respective files. Describe alternatives that have been considered

Open an issue automatically, automatically comment on the respective (first) PR.

ann0see avatar Jan 23 '22 21:01 ann0see

I think we can at least have a check. I'm not sure yet if automatically creating a PR is possible in a sane way, especially due to the fact that we distinguish translations and code contributions.

hoffie avatar Jan 23 '22 21:01 hoffie

Other options:

  • No automation: Add a checklist item for contributors to add themselves? Advantage: Decentralized work, people can add themselves in the right places and can choose the appropriate name.
  • Semi-automation: Have a CI check remind first-time submitters to add themselves

hoffie avatar Jan 23 '22 23:01 hoffie

Other option (probably the easiest): https://github.com/marketplace/actions/welcome-new-users set up this option and remind first PR contributors to add themselves.

ann0see avatar Feb 03 '22 19:02 ann0see

Looks perfect!

I'm never entirely comfortable with forcing someone to take credit for something they don't feel they want to be credited for. Having the commit history can be enough.

Ideally we'd have the ChangeLog checked by CI - but it's a bit of a circular dependency: you need the PR to trigger the check, but you won't know the PR id until you raise it, so you can't add your ChangeLog entry...

pljones avatar Feb 03 '22 20:02 pljones

Since I closed my PR and don't plan to work further on it, I'll hand this issue over to anyone who wants to take it over. Therefore unsubscribing.

ann0see avatar Apr 22 '22 19:04 ann0see