Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (54 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 2.28 KB

Contributing to HomeCloud

Thank you for your interest in contributing to HomeCloud! Whether you're fixing bugs, adding features, improving documentation, or suggesting ideas, we appreciate your help.

How to Get Started

  1. Fork the Repository
    Create a fork of this repository in your GitHub account to work on your contributions.

  2. Clone Your Fork
    Clone your forked repository to your local machine.

    git clone https://github.com/drk1rd/homecloud.git
cd homecloud

  3. Create a Branch
    Create a new branch for your changes. Use a descriptive name for the branch.

    git checkout -b feature/my-new-feature

  4. Make Changes
    Implement your changes or fixes. Ensure the code adheres to the coding standards outlined below.

  5. Test Your Changes
    Before submitting, test your changes locally to ensure they work as intended.

  6. Commit Your Changes
    Write clear and concise commit messages.

    git add .
git commit -m "Add feature: my-new-feature"

  7. Push to Your Fork
    Push your changes to your forked repository.

    git push origin feature/my-new-feature

  8. Create a Pull Request (PR)
    Submit a pull request to the main repository. Include a clear description of the changes you've made and why they are important.

Guidelines

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Coding Standards

  • Follow the conventions of the tech stack.
  • Write clean, modular, and well-documented code.
  • Ensure backward compatibility wherever possible.

Issues and Discussions

  • Browse existing Issues before opening a new one to avoid duplicates.
  • Use the appropriate labels for categorization when creating an issue.

Commit Messages

  • Use meaningful and descriptive commit messages.
  • Format: type(scope): description
  • Examples:
    • fix(storage): resolve upload bug
    • feat(dashboard): add bucket creation UI

Need Help?

If you’re stuck or need clarification, feel free to:

We’re excited to have you on board. Let’s build something great together!