Skip to content

DOC: Improve first time contributor welcome message #24

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 1 commit into from
Apr 23, 2025

Conversation

jhlegarreta
Copy link
Contributor

@jhlegarreta jhlegarreta commented Apr 5, 2025

Improve first time contributor welcome message in GitHub Actions workflow file:

  • Improve the readability by separating paragraphs with empty lines, using a numbered list, using syntax highlighting (bold faces, links).
  • Reword some passages to provide a more compact message, potentially improving the effectiveness of the message.
  • Remove the mention to Russ as an author as he is not listed in the .zenodo.json file.
  • Add emojis to make it more visually appealing.

Modify the CONTRIBUTING.md file to point to the Contributing guidelines section of the NiPreps repository.

Changes proposed in this pull request

(see the above commit message).

Documentation that should be reviewed

Does not apply to the PR.

Copy link

welcome bot commented Apr 5, 2025

Welcome, new contributor!
We ask you to read through the Contributing Guide: https://github.com/nipreps/fmripost-template/blob/main/CONTRIBUTING.md
These are guidelines intended to make communication easier by describing a consistent process, but don't worry if you don't get it everything exactly "right" on the first try.
To boil it down, here are some highlights:

  1. Consider starting a conversation in the issues list before submitting a pull request. The discussion might save you a lot of time coding. 2) Please use a descriptive title for your pull request. Please remember to set your pull request as a "draft" if it is not ready for review. 3) Any code you submit will be licensed under the same terms (Apache License 2.0) as the rest of fMRIPost-template. 4) We invite every contributor to add themselves to the .zenodo.json file (https://github.com/nipreps/fmripost-template/blob/main/.zenodo.json), which will result in your being listed as an author at the next release. Please add yourself as the next-to-last entry, just above Russ.
    A pull request is a conversation. We may ask you to make some changes before accepting your PR, and likewise, you should feel free to ask us any questions you have.

@jhlegarreta
Copy link
Contributor Author

I guess there is no way to tell that the appearance of this will be like the one expected until it it merged and another first time contributor walks in.

Copy link

codecov bot commented Apr 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 26.36%. Comparing base (0448905) to head (c80f9b6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #24   +/-   ##
=======================================
  Coverage   26.36%   26.36%           
=======================================
  Files          19       19           
  Lines        1358     1358           
  Branches      202      202           
=======================================
  Hits          358      358           
  Misses        990      990           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jhlegarreta jhlegarreta force-pushed the ImproveContributorWelcomeMsg branch from af45aaa to 33d941e Compare April 6, 2025 21:50
@jhlegarreta jhlegarreta force-pushed the ImproveContributorWelcomeMsg branch from 33d941e to 0b967bd Compare April 16, 2025 00:20
Improve first time contributor welcome message in GitHub Actions
workflow file:
- Improve the readability by separating paragraphs with empty lines,
  using a numbered list, using syntax highlighting (bold faces, links).
- Reword some passages to provide a more compact message, potentially
  improving the effectiveness of the message.
- Remove the mention to Russ as an author as he is not listed in the
  `.zenodo.json` file.
- Add emojis to make it more visually appealing.

Modify the `CONTRIBUTING.md` file to point to the `Contributing
guidelines` section of the NiPreps repository.
@jhlegarreta jhlegarreta force-pushed the ImproveContributorWelcomeMsg branch from 0b967bd to c80f9b6 Compare April 16, 2025 00:21
Copy link
Collaborator

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

LGTM! Sorry I didn't notice this PR before now.

@jhlegarreta
Copy link
Contributor Author

Feel free to merge @tsalo; I do not have merge rights in this repository.

@tsalo tsalo merged commit 4ee535e into nipreps:main Apr 23, 2025
11 checks passed
@tsalo tsalo added the documentation Improvements or additions to documentation label Apr 23, 2025
@jhlegarreta jhlegarreta deleted the ImproveContributorWelcomeMsg branch April 23, 2025 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants