Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate welcome messages for new contributors and link to guides #476

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

RayStick
Copy link
Member

@RayStick RayStick commented Jan 9, 2025

Closes #
References #316

This PR adds welcome messages when a contributor (1) creates their first issue (2) creates their first PR and (3) merges their first PR. These messages make new contributors feel appreciated for their contributions, but can also act as a way of including a link to contributor guides.

Proposed Changes / More Details

  • A config.yml file has been added that uses a welcome bot to automatically generate a reply in the thread of an Issue or PR, if it notices that this is the first issue/PR/merge for this user within this repo
  • The screenshots below show what these welcome messages look like

❓ Questions:

  • Do we like the thank you logo or shall we just keep to text?
  • The messages are pretty sparse right now, mainly just linking a new contributor to the contributor docs. The advantage of this is that if contributor guidelines change, we do not need to change this welcome bot message. Also, we currently have a checklist within Issue templates and PRs templates. However, if people want to add anything else to these messages that can be done of course.

First Issue

first_issue

First PR

first_PR

First merge

first_merge

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@github-actions github-actions bot added the Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog label Jan 9, 2025
@RayStick RayStick changed the title add welcome messages Add welcome messages to new contributors and link to guides Jan 9, 2025
@RayStick RayStick added the Skip release This PR preserves the current version when merged, and doesn't appear in the changelog label Jan 9, 2025
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.15%. Comparing base (a4d4d69) to head (6de2901).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #476   +/-   ##
=======================================
  Coverage   91.15%   91.15%           
=======================================
  Files           8        8           
  Lines        1006     1006           
=======================================
  Hits          917      917           
  Misses         89       89           

@RayStick RayStick changed the title Add welcome messages to new contributors and link to guides Auto-generate welcome messages for new contributors and link to guides Jan 9, 2025
@RayStick RayStick requested review from m-miedema and smoia January 9, 2025 13:47
@RayStick RayStick marked this pull request as ready for review January 9, 2025 13:47
@RayStick
Copy link
Member Author

RayStick commented Jan 9, 2025

@smoia and @m-miedema I put you both down as reviewers but please add/replace with others that you think would be good to review this PR, if necessary. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog Skip release This PR preserves the current version when merged, and doesn't appear in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant