Github Action Contributors

Overview

The GitHub Action for Contributors is an innovative tool designed to enhance the way you display contributor information directly within your markdown files. By leveraging the GitHub API, this action fetches and dynamically generates an SVG image URL, showcasing a list of contributors. Whether you're a developer looking to add a personal touch to your project's README or simply want to acknowledge the hard work of your collaborators, this action makes it easy to present contributions in a visually appealing format.

With its flexibility and range of features, this action offers users a seamless way to generate contributor lists that can be customized to fit the needs of any project. From bot users to collaborators, it’s an essential addition for maintaining transparency and recognizing contributions in a collaborative environment.

Features

• Dynamic Image Generation: Automatically creates an SVG image URL that displays the contributor list, streamlining the process of showcasing team efforts in your documentation.

• Customizable Output: Options to adjust output formats, including HTML tables and lists, allowing for versatile presentation styles to suit various markdown formats.

• Flexible Filtering: Use regular expressions to filter contributors by author, making it easy to customize who appears on your list.

• Token Authentication: Requires a GitHub token to access contributors securely, ensuring that only authorized actions are performed.

• Adjustable Display Settings: Control username truncation, avatar sizes, and margins for a polished look that fits within your project's design.

• Count Limitation: Specify the maximum number of contributors to display (up to 100), allowing you to manage visibility according to your preference.

• Templates for SVG: Utilize templated designs for your SVG output, ensuring consistency and branding aligned with your project's aesthetics.