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

Automate Contributors Section in README #354

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Conversation

neeru24
Copy link
Contributor

@neeru24 neeru24 commented Oct 20, 2024

Pull Request: Automate Contributors Section in README

fixes: #340
Kindly merge it @suryanshsk

Description:

This pull request introduces automation for the contributors' section in the README file of our project. Previously, we manually updated the contributors' data within tables, which was time-consuming and prone to errors. With this update, the contributors' section is now dynamically generated, making it more efficient and accurate.

Key Changes:

  • Dynamic Contributors Section: The contributors' images and names will automatically update based on contributions made to the repository, ensuring that all contributors are accurately represented.

  • Visual Appeal: The contributors are displayed using a scrolling format, enhancing the overall aesthetics of the README file.

  • GitHub Actions Integration: We’ve implemented a GitHub Action that automatically updates the contributors' section whenever changes are pushed to the main branch. This reduces the need for manual intervention and keeps the contributors' list current.

Benefits:

  • Efficiency: Reduces the manual workload required to maintain the contributors' section.
  • Accuracy: Ensures that all contributors are recognized without the risk of missing any contributions.
  • Improved User Experience: The scrolling contributor images create a more engaging and visually appealing README.

Before:

Screenshot 2024-10-19 130446

After:

Screenshot 2024-10-20 130746
image

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🎉 Thank you @neeru24 for your contribution! Your pull request has been submitted successfully. A maintainer will review it as soon as possible. We appreciate your support in making this project better

@suryanshsk suryanshsk merged commit b4a5695 into suryanshsk:main Oct 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐞[BUG] Incorrect Code Snippet in Contributors Table
2 participants