Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 1.94 KB

Contributing to This Project

Thank you for your interest in contributing to this project! We appreciate your help in improving and maintaining this repository.

Getting Started

Before you begin contributing, please ensure that you have read and understood the following guidelines.

Code of Conduct

This project follows a Code of Conduct. By participating, you agree to abide by its terms.

How to Contribute

Reporting Issues

If you find a bug, have a feature request, or need clarification, please open an issue following these steps:

  1. Search existing issues to avoid duplicates.
  2. Clearly describe the issue with steps to reproduce if applicable.
  3. Include relevant logs, screenshots, or additional context.

Submitting Pull Requests

To submit a contribution via a pull request (PR):

  1. Fork the repository and clone it locally.
  2. Create a new branch for your changes: git checkout -b <branch-type>/<issue number | thing>.
  3. Make your changes and ensure they align with the project’s coding standards.
  4. Test your changes thoroughly.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request with a clear title and description.

Code Style

  • Follow the existing coding conventions and style.
  • Ensure code is well-documented where necessary.
  • Format code before submitting a PR.

Commit Messages

Use clear and concise commit messages. A good format is:

feat: add new profile feature for EstateEase
fix: resolve pagination issue in property list
chore: a change that is not a new feature or a bug fix

Reviewing and Merging PRs

  • PRs will be reviewed by maintainers.
  • Address requested changes promptly.
  • Once approved, a maintainer will merge the PR.

Questions or Help

If you need help or have questions, feel free to ask in the discussions or issues section.

Thank you for contributing! 🚀