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

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

Open
lcrojano opened this issue Oct 27, 2024 · 2 comments · May be fixed by #196
Open

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

lcrojano opened this issue Oct 27, 2024 · 2 comments · May be fixed by #196
Assignees
Labels
enhancement New feature or request hacktoberfest This issue is related to Hacktoberfest

Comments

@lcrojano
Copy link

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 lcrojano added the enhancement New feature or request label Oct 27, 2024
@lcrojano
Copy link
Author

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
Copy link
Owner

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

@Morphclue Morphclue added the hacktoberfest This issue is related to Hacktoberfest label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest This issue is related to Hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants