search

Morphclue / apollusia

Calendar tool for coordinating meetings
http://apollusia.com
MIT License
7 stars 5 forks source link

include CONTRIBUTING.md. To improve community contributions, #195

Open lcrojano opened 3 weeks ago

lcrojano commented 3 weeks ago

Context

Establishing a CONTRIBUTING.md file is essential to guide new contributors and streamline the development process. This file will include coding standards, pull request guidelines, and best practices, helping to maintain consistency across contributions, minimize onboarding time, and reduce potential errors or misunderstandings.

Alternatives

An alternative approach could be hosting this information in a dedicated documentation site or within the repository’s README.md. However, placing contribution guidelines in a separate CONTRIBUTING.md file is preferred for better visibility and organization.

References

Example CONTRIBUTING.md files from other popular open-source repositories (e.g., GitHub Docs) Basic etiquette for open-source contributions to guide new contributors.

lcrojano commented 3 weeks ago

Hi! I would like to work on this issue as part of Hacktoberfest. Adding a CONTRIBUTING.md file would be a valuable enhancement to issue #134.

Thank you for considering!

Morphclue commented 3 weeks ago

Sure a CONTRIBUTING.md seems like a good suggestion. Would also be great if you could strongly suggest contributors to use conventional commits.