Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.74 KB

Contributing.md

File metadata and controls

74 lines (50 loc) · 2.74 KB
Raw

🎉 Welcome to the CabRental Contributing Guide

We're thrilled that you're considering contributing to CabRental, a decentralized vehicle rental platform! Whether you're fixing a bug, proposing new features, or improving documentation, your contributions are vital to improving the platform and making vehicle rentals smarter, faster, and more secure. 🚗💨

🛠 How to Contribute

We aim to make contributing easy and efficient. Follow the steps below to get started.

1. Fork the Repository 🍴

Start by forking the repository:

  • Navigate to the top-right corner of this page.
  • Click the Fork button.
  • This creates your personal copy of CabRental to make modifications.

2. Clone the Forked Repository 🛠️

Clone your fork to your local machine to work on:

git clone https://github.com/YOUR-USERNAME/CabRental.git

Then, navigate to the project directory:

cd CabRental

3. Set Up Your Environment ⚙️

Install all the required dependencies to run the project locally:

npm install
composer install

Make sure to configure MetaMask for decentralized login and connect it with the blockchain environment.

4. Make Changes ✏️

Start contributing by working on the issue or feature. You can check out our Issue Tracker to find open tasks. Don’t forget to follow our code guidelines and document your changes properly.

5. Commit Your Changes 💾

Once you’re done making changes, commit them with a clear message:

git add .
git commit -m "Description of changes"

6. Push to Your Fork 🚀

Push your changes to the forked repository:

git push origin main

7. Open a Pull Request 🎯

Once you've pushed your changes, open a Pull Request (PR) to the main repository. Make sure to provide a clear description of the changes made and link the issue, if applicable.

We recommend writing an informative PR title and including screenshots or GIFs (if necessary) to demonstrate the feature or bug fix.

🔍 Code Guidelines

To maintain code consistency and quality, ensure you follow these guidelines:

  • Coding Style: Adhere to industry standards and follow JavaScript Style Guides.
  • Test: Test your code thoroughly before pushing. We encourage adding unit and integration tests whenever possible.
  • Documentation: Always update or add documentation for any feature or code changes.
  • Smart Contracts: Follow secure development principles for writing and testing smart contracts.

📬 Have Questions?

Need help? Have questions? Feel free to reach out by opening an issue.

Thank you for helping us make CabRental better! 🎉