Detecting newcommers

[etobella]

In the Community Health WG, we proposed to detect newcommers in their first PR and share information with them. The idea is to provide them the necessary documentation (like CLA Agreement, conventions and so on) in a welcome pack message.

Part of the group is working on the documentation and I was checking how to share it with people.

I found https://github.com/plbstl/first-contribution/tree/main an action that might work, but it is only working for each repo individually. I am also working on a change of it so it detects the first PR for all the organization. From your side, what should be better, a comment on each first contribution on a repository or by organization?

Another question is, if we want to use it, I would recommend to define the rule here and make use of

https://docs.github.com/en/actions/how-tos/reuse-automations/reuse-workflows

This way, if we want to change the message, we can do it globally and there is no need for a copier change everywhere. I understand that it makes no sense for other actions, but for this specific one, it might be an improvement if we want to make small improvements. WDYT?

@sbidoul @pedrobaeza @yostashiro @arielbarreiros96 @jbaudoux @TumbaoJu

[pedrobaeza]

If you don't want to complicate, isn't too much to have that comment on each repository, and that can be an occasion to have specific instructions per repo, for example for those like queue and mis-builder that have their own way.

[etobella]

Well, that opens us to have a generic one and define specific things for some repositories (or leave the option to add some extra information).

I do agree that it is much cleaner to have one for organization. In that case, it is not a problem, as I already prepared it 😉

[pedrobaeza]

Great then. I just want to save you work.

[etobella]

Well, I was able to make it work:

The action is not so hard:

name: Welcome First-Time Contributor

on:
  issues:
    types: opened
  pull_request_target:
    types: opened

permissions: {}

jobs:
  welcome:
    runs-on: ubuntu-latest
    permissions:
      issues: write # Required to post comments and labels on issues
      pull-requests: write # Required to post comments and labels on PRs
    steps:
      - uses: dixmit/first-contribution@2.0.0
        with:
          labels: first-contribution
          issue-opened-msg: |
            ### Hey @{fc-author}! :wave:

            Thanks for opening your first issue. Welcome to the community! :heart:
          pr-opened-msg: |
            ### Hey @{fc-author}! :tada:

            Thanks for opening your first pull request. We really appreciate it.

Obviously, the action would be passed to OCA 😄

My recommendation would be to add changes on the copier template and add two new options:

1- Add standard welcome for new contributors
2- Specific documentation for this repository (would allow us to make specific comments for people making their first PR on special repositories, like queue. Main body of this message could be generic, but extra things would be dynamic.

It works with pull requests and issues, but messages can be different for each one.

[arielbarreiros96]

Hello @etobella I think making the action that detect the contributions for each repo makes good sense. Actually it allows to fine tune some info/instructions that are specific for some repos like @pedrobaeza mentioned before

I've also seen the code/docs here here and it seems like it is only taking into account issues and PRs (later I saw your last sentence, it confirms it 😅), shouldn't we include reviewers? I mention this cause some functional members mostly (or sometimes only) contribute with functional reviews

[sbidoul]

I think this is a good opportunity to try org-wide GitHub workflows. In case there are specific contribution guidelines for a specific repo they can be added to https://github.com/oca/{repo}/?tab=contributing-ov-file via a local CONTRIBUTING.md.