Skip to content

Comments

Rename CONTRIBUTING.md to JabsCONTRIBUTING.md#1

Open
jarlungoodoo73 wants to merge 3 commits intomainfrom
jarlungoodoo73-patch-1
Open

Rename CONTRIBUTING.md to JabsCONTRIBUTING.md#1
jarlungoodoo73 wants to merge 3 commits intomainfrom
jarlungoodoo73-patch-1

Conversation

@jarlungoodoo73
Copy link
Owner

@jarlungoodoo73 jarlungoodoo73 commented Dec 4, 2025

[This](

url

) workflow triggers a SonarQube analysis on code pushes and pull requests to the main branch, integrating with GitHub for vulnerability scanning.

Description

Motivation and Context

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (change that has absolutely no effect on users)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
    [

Description

Motivation and Context

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (change that has absolutely no effect on users)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed. ](url)

Summary by Sourcery

New Features:

  • Introduce a GitHub Actions workflow that posts greeting messages on users' first issues and pull requests.

Copilot AI review requested due to automatic review settings December 4, 2025 02:25
@sourcery-ai
Copy link

sourcery-ai bot commented Dec 4, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a new GitHub Actions workflow to automatically post greeting messages on a user's first issue or pull request in the repository.

Sequence diagram for first interaction greetings workflow

sequenceDiagram
    actor User
    participant GitHub
    participant GreetingsWorkflow
    participant FirstInteractionAction

    User->>GitHub: Open first issue or pull request
    GitHub-->>GreetingsWorkflow: Trigger pull_request_target or issues event
    GreetingsWorkflow->>FirstInteractionAction: Run actions/first-interaction@v1 with repo_token
    FirstInteractionAction->>GitHub: Check if User has prior issues or pull requests
    alt First interaction
        FirstInteractionAction->>GitHub: Post issue-message or pr-message comment
    else Not first interaction
        FirstInteractionAction-->>GitHub: Do nothing
    end
    GitHub-->>User: Display greeting comment on issue or pull request
Loading

File-Level Changes

Change Details Files
Introduce an automated greeting workflow for first-time issues and pull requests using GitHub Actions.
  • Add a greetings.yml workflow triggered on pull_request_target and issues events
  • Configure the workflow to run on ubuntu-latest with write permissions to issues and pull requests
  • Use actions/first-interaction@v1 with the repository token to post customizable first-issue and first-PR messages
.github/workflows/greetings.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • Using pull_request_target can have security implications because it runs with elevated permissions on code from forks; consider whether pull_request is sufficient here or add additional safeguards (e.g., limiting to trusted branches or adding manual approval).
  • The issue-message and pr-message strings are very generic placeholders; consider updating them with concrete onboarding or contribution guidance tailored to this repository to make the interaction more useful.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Using `pull_request_target` can have security implications because it runs with elevated permissions on code from forks; consider whether `pull_request` is sufficient here or add additional safeguards (e.g., limiting to trusted branches or adding manual approval).
- The `issue-message` and `pr-message` strings are very generic placeholders; consider updating them with concrete onboarding or contribution guidance tailored to this repository to make the interaction more useful.

## Individual Comments

### Comment 1
<location> `.github/workflows/greetings.yml:3` </location>
<code_context>
+name: Greetings
+
+on: [pull_request_target, issues]
+
+jobs:
</code_context>

<issue_to_address>
**🚨 suggestion (security):** Consider whether `pull_request_target` is necessary here from a security perspective.

`pull_request_target` runs with base-repo secrets and a write-scoped `GITHUB_TOKEN`, even for forks. For this greeting job that only needs to comment on PRs, `pull_request` should be sufficient and reduces exposure of secrets and write access. Unless you need `pull_request_target`’s elevated privileges, prefer `pull_request` here.

```suggestion
on: [pull_request, issues]
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Despite the title "Rename CONTRIBUTING.md to JabsCONTRIBUTING.md", this PR actually adds a new GitHub Actions workflow file for greeting first-time contributors. The PR title and description do not match the actual changes being made.

Key Changes:

  • Adds a new greetings.yml GitHub Actions workflow
  • Configures automated greetings for first-time issue creators and PR authors
  • Uses the actions/first-interaction@v1 action

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jarlungoodoo73
Copy link
Owner Author

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link

Copilot AI commented Dec 4, 2025

@jarlungoodoo73 I've opened a new pull request, #2, to work on those changes. Once the pull request is ready, I'll request review from you.

Update

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

2 participants