Skip to content

build: bring first-time greeting script in-house #5833

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

Merged
merged 4 commits into from
Apr 9, 2025

Conversation

Planeshifter
Copy link
Member

Description

What is the purpose of this pull request?

This pull request:

  • replaces usage of the actions/first-interaction action, which we had frequent issues with, with our own in-house script.

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

I left the content of the posted comments the same for now. It's not clear to me what changes would be desirable: For example, I thought first it may be a good idea to mention slash commands on first PR, but since any workflow runs have to be approved at that point, it's actually not a good idea to point new contributors to this functionality. Similarly, I was thinking of linking to contribution and development guide, but people should have done that before raising a PR and it's probably better to have presumption of innocence instead of auto-assuming people need to be reminded of our development practices.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: passed
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@kgryte
Copy link
Member

kgryte commented Mar 9, 2025

Re: updating comment. In offline discussions, we discussed

Update bot comment for first PR by a new contributor with more helpful instructions and orientation

I believe the idea was to, e.g., provide a list of make commands with example usage for compiling native add-ons and running tests, examples, benchmarks, etc. We could also provide an overview of the review process. E.g., a reviewer will take a look. If things seem in a good enough state, a maintainer will approve GitHub workflows. If those fail, please try to remedy any failures. To reproduce build failures locally, run the following commands. We could also state that, if a maintainer has not responded within 2 weeks, please feel free to ping the "reviewers" team by leaving a comment on this PR. You can also link to the developer FAQ. Etc.

In short, I think you can probably use your imagination a bit more for what would be potentially helpful.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. Tools Issue or pull request related to project tooling. CI Issue or pull request specific to continuous integration environments. and removed Needs Review A pull request which needs code review. labels Mar 9, 2025
@Planeshifter Planeshifter added the Potential Duplicate There might be another pull request resolving the same issue. label Mar 15, 2025
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: passed
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@Planeshifter Planeshifter added Needs Review A pull request which needs code review. and removed Needs Changes Pull request which needs changes before being merged. Potential Duplicate There might be another pull request resolving the same issue. labels Apr 5, 2025
Signed-off-by: Athan <kgryte@gmail.com>
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM. Although, again, we really should not be inlining Markdown documents in Bash scripts. It makes scripts much harder to grok, and it circumvents all the Markdown linting processes we've created.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 9, 2025
@kgryte kgryte merged commit 5c5c9f8 into develop Apr 9, 2025
9 checks passed
@kgryte kgryte deleted the philipp/first-time-greeting-script branch April 9, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Issue or pull request specific to continuous integration environments. Tools Issue or pull request related to project tooling.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: Write custom scripts to leave comment for first issues and first PRs
3 participants