Roomie.sol

A platform for booking rooms using crypto

How to Contribute?

Follow these steps to set up and run the project locally:

1. Fork the repository

a) Fork the repository to your GitHub by creating a new fork.

b) Clone the Repository:

To clone the repository, go to forked repo and click on code and copy the repo link and enter the following command in your terminal.

  git clone https://github.com/your-profile-name/Roomie.sol.git

2. Go to the project directory:

  cd dwellChain

3. Install dependencies

a) if not installed pnpm globally

  npm install -g pnpm

Check version to know if installed

  pnpm --version

then, install dependencies

  pnpm install

4. Start the server

  pnpm run dev

5. Create a branch with the branch name similar to issue name.

  git checkout -b your-branch-name

6. After successfully contribution

a. Stage and commit changes to the branch

  git add <all the files>
  git commit -m "first commit"

b. Push the changes to the remote repository

  git push origin your-branch-name

c. Merge the add-readme branch into main

After pushing, you can create a pull request to merge the "your-branch" branch into main.

  git checkout main
  git pull origin main  # Ensure your local main is up to date
  git merge <your-branch-name>

d. Push the merge to the main branch

  git push origin main

7. Create a Pull Request in the forked repo:

a. Go to https://github.com/Tufailahmed-Bargir/Roomie.sol

b. Go to Pull Requests, in the comparison of changes section.

c. Select your branch.

d. Create a Pull Request by adding the title as issue name and tag and adding a description to the PR.

That’s it! You have successfully merged your contribution into the main branch.

Thanks a lot!!!