How to Contribute

Welcome to Contributing link

Thanks for considering contributing to Homelab-Alpha! Your interest and effort are invaluable to our community’s growth and the enhancement of our project. Below are some guidelines to streamline your contribution process:

Issues link

• Check Existing Issues: Take a look at our list of existing issues to see if someone is already working on the problem or feature you’re interested in. If there’s an open issue, consider contributing to it.
• Creating New Issues: If you’re opening a new issue, ensure it’s clear and concise. Provide detailed descriptions, including steps to reproduce any problems.
• Indicate Willingness to Work: When submitting a new issue, let us know if you’re willing to work on a solution.

Pull Requests link

• Alignment with Project Goals: Before sending a pull request, ensure your contribution aligns with our project’s objectives. For significant changes, discussing them in an issue beforehand is beneficial.
• Coding Standards: Keep your code neat and consistent with our coding standards,

Workflow and Versioning link

We follow the GitHub flow for our versioning workflow.

When you’re working on something:

1. Fork the repository.
2. Create a new branch for your task.
3. Send a pull request from your branch to our main branch.

Style Guide link

• Make sure your pull requests adhere to the Conventional Commits specification and our Code Style + Standards Guides.

How Can You Help? link

Keep Homelab-Alpha Up-to-Date link

If you notice updates to your favorite operating systems or tools, feel free to open a pull request to incorporate them into Homelab-Alpha. Your contribution will undergo review and merge once validated.

Enhance Documentation and Knowledge Base link

At Homelab-Alpha, we’re committed to nurturing an educational environment where everyone can contribute to enhancing our documentation. If you excel in writing technical documentation, consider contributing to documents that aid others in learning and growing.

Share Your Ideas link

We’re always eager to hear your innovative ideas and suggestions for new projects. Share your thoughts or concepts using the ideas link. Your input helps shape our future endeavors!

Licensing link

By contributing, you agree to license your work under the Homelab-Alpha license. If you have any objections to changes in the license, please communicate them to us promptly.

Enjoy and Have Fun link

Thanks for contemplating contributing to Homelab-Alpha. Together, we can elevate and refine our project for the entire community to benefit from. We eagerly anticipate your contributions!