Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

96 lines (64 loc) · 3.29 KB
Raw

Contributing to Rentalog.in

Thank you for your interest in contributing to Rentalog.in! We welcome contributions from everyone, whether you're fixing bugs, suggesting new features, improving documentation, or helping with testing.

How to Contribute

1. Fork the Repository

  • Click the "Fork" button at the top right of this page to create a personal copy of the repository.

2. Clone Your Fork

  • Clone your forked repository to your local machine:
  git clone https://github.com/your-username/Rentalog.in.git
  • Replace your-username with your GitHub username.

3. Create a New Branch

  • Create a new branch for your feature or bug fix:
git checkout -b your-feature-branch

Use a descriptive name for your branch, such as feature/add-tenant-management or bugfix/fix-rent-calculation.

4. Make Your Changes

  • Make your changes in the codebase. Ensure that you:
  • Follow the existing coding style.
  • Write clear and concise commit messages.
  • Keep your commits focused on a single issue or feature.

5. Test Your Changes

  • Run the application locally and ensure that your changes work as expected. If applicable, add unit tests to verify your modifications.

6. Commit Your Changes

  • Stage your changes and commit them:
git add .
git commit -m "Add a meaningful commit message"

Ensure your commit messages follow the convention: type(scope): subject (e.g., feat(tenant): add tenant management feature).

7. Push to Your Fork

  • Push your changes to your forked repository:
git push origin your-feature-branch

8. Open a Pull Request

  • Go to the original repository and click on the "New Pull Request" button.

  • Select your branch and submit your pull request. Provide a clear description of your changes and reference any related issues.

Types of Contributions

  • Bug Reports If you find a bug, please open an issue in the Issues section. Include the following information:

  • Steps to reproduce the bug.

  • Expected behavior.

  • Actual behavior.

  • Screenshots, if applicable.

  • Feature Requests

We welcome suggestions for new features! Please open an issue with the label Feature Request and describe:

  • The feature you'd like to see.
  • How it would improve the application.
  • Any relevant examples or use cases.

Documentation Improvements

If you notice any errors or areas for improvement in the documentation, feel free to submit a pull request with your changes. Clear and comprehensive documentation helps everyone!

Design Contributions

If you're interested in contributing to the design aspect, please create mockups or suggest improvements for the user interface.

Code of Conduct

By participating in this project, you agree to abide by our [Code of Conduct]. We strive to create a welcoming environment for all contributors.

Resources GitHub Flow Markdown Guide React Documentation

Questions?

If you have any questions or need further assistance, feel free to reach out to the maintainers or join the discussions in the Discussions section.

Thank you for contributing to Rentalog.in! Your support helps us improve the project for everyone.