Skip to content

Articles

Estimated reading time 0 min

Display Your Sponsors in Your GitHub READMEs

Showcasing your sponsors in GitHub READMEs is a great way to acknowledge their support and attract potential sponsors. An easy way to do this is by using SponsorKit, developed by Anthony Fu. SponsorKit generates sponsor images compatible with GitHub Sponsors, Open Collective, Patreon, and Afdian. By following a few steps, you can create and display these sponsor images in your project’s README file. You’ll need a GitHub account, at least one sponsor, and a personal access token. A template repository is available to simplify the setup process.

Can I Take This Issue?

Open-source software development thrives on the contributions of volunteers with varying skills and backgrounds. Project maintainers play a critical role in ensuring these contributions are of high quality and align with the project’s goals. However, issues arise when contributors do not read guidelines or maintainers do not assign issues, leading to confusion and frustration. This lack of clear communication can leave contributors feeling undervalued and discourage them from contributing further.

Maintainers have different reasons for not assigning issues, such as limited resources and large communities. Assigning issues can enhance efficiency, accountability, and resource management but may also create perceptions of favoritism or stifle collaboration. To address these challenges, maintainers should establish clear communication channels, use tools like saved replies, and maintain comprehensive contribution guidelines. By fostering a transparent and supportive environment, maintainers can better manage contributions and maintain a healthy, active community.

How to Create a Code of Conduct for an Open-Source Project

Creating a code of conduct is vital for fostering a safe and welcoming community within an open-source project. Often, this document is prepared before the community even forms, setting clear expectations and behavioral guidelines from the outset. The process includes defining goals and scope, researching existing codes of conduct, drafting, reviewing and approving the document, publishing, and regularly updating it. Having a code of conduct helps establish a positive social atmosphere, protecting participants and maintainers from unproductive attitudes and ensuring a supportive environment for all.

A well-defined code of conduct outlines expected behaviors, the scope of its application, and procedures for handling violations. The Contributor Covenant is a widely-adopted example, promoting respect and inclusion within open source communities. By researching existing codes like the Contributor Covenant, Ubuntu Code of Conduct, and others, project maintainers can identify best practices to incorporate. Once drafted, the document should be reviewed by key stakeholders and communicated clearly to the community. Regular reviews ensure the code remains relevant and effective, fostering a healthy, collaborative environment and addressing any violations appropriately to maintain community standards.