Skip to content

Welcome Newcomer

Post a welcome message when someone makes their first PR to a repo, and provide context to help them know what's next.

Welcome Newcomer

Configuration Description

Conditions (all must be true):

  • The PR author made their first contribution to the repo during the current day.

Automation Actions:

  • Add the my-organization/mentors team to review the PR. Customize this to match your organization.
  • Apply a new-contributor label to the PR.
  • Post a comment explaining the next steps. Customize this to match your project.

Welcome Newcomer

# -*- mode: yaml -*-
manifest:
  version: 1.0

automations:
  # Help newcomers find mentors to guide them.
  welcome_newcomer:
    # If the PR author made their first contirbution on the current day
    if:
      - {{ repo.author_age < 1 and repo.age > 0 }}
    # 1. Add reviewers from the team `my_organization/mentors`. Replace this string to match your organization
    # 2. Apply a new-contributor label.
    # 3 Post a comment that explains the next steps.
    run:
      - action: add-reviewers@v1
        args:
          reviewers: [my_organization/mentors]
      - action: add-label@v1
        args:
          label: 'new-contributor'
          color: '#FBBD10'
      - action : add-comment@v1
        args:
          comment: |
            Hello {{ pr.author }} 👋 Thanks for making your first PR, and welcome to our project!
            Our mentor team has automatically been assigned to review this PR and guide you through the process.
            Please reach out to that team if you have questions about the next steps.
Download this example as a CM file.

Additional Resources

gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.

Learn More about how gitStream Works.

Related Automations:

More Automations can be found on the Automation Library and Integrations pages.