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

feat: greet first time contributors #1316

Merged
merged 7 commits into from
Dec 24, 2024

Conversation

monilpat
Copy link
Collaborator

Relates to:

Leverage out of the box github workflows

Risks

  • Risk Level: Low
  • Potential Impact: The workflow introduces automated messages for first-time contributors. If misconfigured, it could send incorrect or unintended messages. However, since it doesn't affect the core codebase, the overall risk is minimal.

Background

What does this PR do?

This PR adds a GitHub Actions workflow that automatically sends personalized greeting messages to users when they open their first issue or submit their first pull request. The messages welcome them to the ai16z community and express appreciation for their contributions.

What kind of change is this?

  • Features (non-breaking change which adds functionality)

Documentation changes needed?

  • My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Review the newly added workflow file located at .github/workflows/greetings.yml.

Detailed testing steps

  1. Fork the Repository: Fork the repository to your personal GitHub account to test the workflow without affecting the main project.

  2. Modify the Workflow: In your fork, navigate to .github/workflows/greetings.yml and ensure the issue-message and pr-message are appropriately set to welcome new contributors.

  3. Create a Test Issue:

    • Navigate to the "Issues" tab in your forked repository.
    • Click on "New Issue" and submit it.
    • Verify that the GitHub Actions bot comments with the specified issue-message.
  4. Create a Test Pull Request:

    • Make a minor change in your forked repository (e.g., edit the README).
    • Commit the change and open a pull request against your fork.
    • Verify that the GitHub Actions bot comments with the specified pr-message.
  5. Review Workflow Execution:

    • Navigate to the "Actions" tab in your forked repository.
    • Ensure that the "Greetings" workflow ran successfully for both the issue and pull request events.
  6. Cleanup:

    • Close the test issue and pull request.
    • Optionally, delete your forked repository.

By following these steps, you can confirm that the greeting workflow functions as intended, providing a welcoming message to first-time contributors.

Discord username

0x8664

added greeting workflow for first time contributors :)
@monilpat monilpat changed the base branch from main to develop December 21, 2024 06:31
@monilpat monilpat changed the title Create greetings.yml feat: Create greetings.yml Dec 21, 2024
@monilpat monilpat changed the title feat: Create greetings.yml feat: greet first time contributors Dec 21, 2024
@odilitime
Copy link
Collaborator

I believe partner is a term for token holders, will need to check on the wording. May have to use "contributor" for now

Base automatically changed from develop to main December 22, 2024 07:01
@monilpat monilpat changed the base branch from main to develop December 22, 2024 21:08
@shakkernerd shakkernerd merged commit 9aefc8a into develop Dec 24, 2024
4 checks passed
@shakkernerd shakkernerd deleted the realitySpiral/greetingworkflow branch December 24, 2024 05:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants