Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.51 KB

README.md

File metadata and controls

26 lines (16 loc) · 1.51 KB
Raw

Housify Documentation

Welcome to the Housify Documentation repository! This page provides essential information on how to contribute to our documentation and report any issues you may encounter.

To access the main Housify repository, please visit Housify on GitHub.

Contributing Guidelines

Thank you for your interest in contributing to our documentation! To ensure a smooth collaboration process, please follow these guidelines:

  • Fork the Repository: Fork the repository and create a new branch for your changes.
  • Adhere to the Style Guide: Make your changes and ensure they adhere to our style guide.
  • Open a Related Issue: Before creating a pull request (PR), open a related issue to discuss the proposed changes. This helps us manage and track improvements effectively.
  • Submit a Pull Request: Submit a pull request with a clear description of your changes, referencing the related issue.

Reporting Issues

If you encounter any issues or have suggestions for improving our documentation, please follow these steps:

  1. Check Existing Issues: Review the existing issues to see if your problem has already been reported.
  2. Create a New Issue: If your issue is not already reported, create a new issue with a detailed description of the problem.
  3. Provide Relevant Information: Include any relevant information, such as error messages or steps to reproduce the issue.

Thank You!

We appreciate your contributions and feedback! Happy documenting!