Skip to content

Conversation

repeat-Q
Copy link

Description: Added a beginner-friendly tip to the README to help first-time contributors find a starting point. This is a documentation improvement aimed at lowering the barrier for newcomers to participate in open source.

Issue: No related issue

Dependencies: None


Note to maintainers

I'm new to open source and this is my first PR! If there's anything that needs improvement, please guide me and I'll be happy to learn and make changes. Thank you for your patience! 😊

What does this PR do?

  • Added a noticeable beginner tip box after the badges section in README
  • Provided specific guidance (Good First Issues link)
  • Encourages newcomers to start with documentation fixes

Why is this change needed?

  • Makes it easier for new contributors to get started
  • Provides clear direction and reduces confusion
  • Creates a more welcoming open source community environment

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 15, 2025
@mdrxy
Copy link
Collaborator

mdrxy commented Oct 15, 2025

Hi @repeat-Q thank you for the submission! We prefer to keep the contributing guidelines consolidated to the CONTRIBUTING.md so as not to crowd the primary README.

I would be open to a modification of this PR that instead includes a link to the contributing guide under the # Additional resources header. Would you mind making this change?

@repeat-Q
Copy link
Author

Hi @repeat-Q thank you for the submission! We prefer to keep the contributing guidelines consolidated to the CONTRIBUTING.md so as not to crowd the primary README.

I would be open to a modification of this PR that instead includes a link to the contributing guide under the header. Would you mind making this change?# Additional resources

Hi! Thank you for the review and the constructive feedback!

I really appreciate you taking the time to guide me through my first contribution. I'd be happy to make the change you suggested.

Just to make sure I understand correctly - you'd like me to:

  1. Remove the beginner tip box from the current location
  2. Instead, add a link to the CONTRIBUTING.md guide in the "Additional resources" section

I'll proceed with these changes. Thank you again for your patience and guidance! 😊

Removed beginner tip about contributing and added a link to the contributing guide.
@repeat-Q
Copy link
Author

Hi @repeat-Q thank you for the submission! We prefer to keep the contributing guidelines consolidated to the CONTRIBUTING.md so as not to crowd the primary README.

I would be open to a modification of this PR that instead includes a link to the contributing guide under the # Additional resources header. Would you mind making this change?

Hi! I've implemented the changes as suggested - this was great practice for the contribution workflow I described in my proposal.

I've:

  • Removed the beginner tip box from the main area
  • Added the contributing guide link to "Additional resources" section

Could you please take a look and let me know if this meets expectations or if there are any other adjustments needed? I'm really appreciating the learning experience! 😊

@mdrxy mdrxy changed the title docs: add beginner-friendly tip to README docs: add contributing guide to README Oct 17, 2025
@mdrxy mdrxy enabled auto-merge (squash) October 17, 2025 22:06
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 17, 2025
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