Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 2.91 KB

Contributing to TenantTalk

We appreciate your interest in contributing to TenantTalk! Your contributions will help make the platform more valuable and beneficial for renters. This document provides guidelines and instructions to help ensure a smooth contribution process.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please ensure your interactions with other contributors remain respectful and inclusive.

How to Contribute

  1. Fork the repository: Fork the TenantTalk repository to your GitHub account.

  2. Clone the forked repository: Clone the forked repository to your local machine.

git clone https://github.com/your_username/TenantTalk.git
  1. Create a new branch: Create a new branch for the feature or bugfix you want to work on.
git checkout -b your_feature_branch

  1. Make your changes: Implement the feature or bugfix, adhering to the coding standards and guidelines described below.

  2. Commit your changes: Commit your changes with a clear and descriptive commit message. Follow the Conventional Commits standard for your commit messages.

  3. Sync your fork: Ensure your fork is up-to-date with the upstream repository.

git fetch upstream
git merge upstream/main
  1. Push your changes: Push the changes in your feature branch to your fork.
git push origin your_feature_branch
  1. Create a pull request: Open a pull request against the main branch of the TenantTalk repository. In the pull request description, provide a clear explanation of the changes you made and their purpose.

Coding Standards and Guidelines

  • Write clean, maintainable, and well-documented code.
  • Follow the established code style and structure of the project.
  • Test your changes thoroughly before submitting a pull request.
  • Break large features or bugfixes into smaller, more manageable pull requests when possible.

Reporting Issues

If you encounter any issues or bugs while using TenantTalk, please open a new issue in the issue tracker. Provide a clear description of the issue and include any relevant information, such as error messages, steps to reproduce the issue, or screenshots.

Feature Requests

If you have a feature request or an idea for improving TenantTalk, feel free to open a new issue in the issue tracker. Describe the feature or improvement you'd like to see and explain how it would benefit the project.

Questions and Support

For general questions, support, or discussion, please use the project's Discussions section.

Thank you for contributing to TenantTalk! Your efforts will help make the platform better for everyone.