Contributing to HouseLearning

Thank you for your interest in contributing to HouseLearning! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct and guidelines outlined below.

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page to create a copy of the project under your GitHub account.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
cd REPO-NAME

3. Create a Feature Branch

Create a new branch for your changes:

git checkout -b my-feature

4. Make Your Changes

Make your changes locally. Please ensure your code follows the existing code style and includes appropriate tests and documentation.

5. Test Your Changes

Run all tests to ensure nothing is broken. Add new tests as needed for your contribution.

6. Commit and Push

Commit your changes and push your branch to your fork:

git add .
git commit -m "Description of your changes"
git push origin my-feature

7. Open a Pull Request

Go to the original repository and open a pull request (PR) from your branch. Please provide a clear and descriptive title and summary for your PR.

Contributing Guidelines

• Code Style: Follow the style and formatting used in the project.
• Commits: Write clear, concise commit messages.
• Pull Requests: Reference related issues (if any) and describe the motivation and context for your changes.
• Documentation: Update documentation as necessary for any code changes.
• Tests: Add or update tests to cover your changes.
• Review: Be responsive to PR feedback, and participate constructively in code reviews.

Reporting Bugs & Requesting Features

• Open an issue on our issue channel and provide as much detail as possible.
• Use labels such as bug, enhancement, or question to help us categorize your issue.

Code of Conduct

Be respectful and inclusive. See our Code of Conduct for more details.

Questions?

If you have any questions or need help, open an issue or start a discussion.

---

Thank you for helping make HouseLearning better!