From b123d11e074274a828bfbc8a604df186f075428b Mon Sep 17 00:00:00 2001 From: Matias Date: Wed, 4 Dec 2024 07:58:24 -0600 Subject: [PATCH] [docs]: Update CONTRIBUTING.md (#78) --- CONTRIBUTING.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++--- README.md | 7 ++--- 2 files changed, 74 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57640a7..d9de6a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,16 +61,76 @@ We welcome contributions from the community! Here's how you can help: > Replace `your-branch-name` with the name of your branch. - Example: - ```bash git push origin fix/bug-fix ``` +6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the CofiBlocks repository. + + - Summit pull request + +# 📌 Update your Fork and Local Repository + +### 🔒 Set up the original repository as upstream (only once) +- **Check your remote.** +```bash +git remote -v +``` + +- **If you don't see `upstream`, add it.** +```bash +git remote add upstream https://github.com/Vagabonds-Labs/cofiblocks.git +``` # -6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository. +### 🔩 Update your Fork +1. **Bring the latest changes from the original repository.** + ```bash + git fetch upstream + ``` +2. **Switch to the `main` branch of your local repository.** + ```bash + git checkout main + ``` +3. **Merge `upstream/main` changes to your local branch.** + ```bash + git merge upstream/main + ``` +4. **Upload the changes to your fork in GitHub.** + ```bash + git push origin main + ``` +# - - Summit pull request +### 🔧 Update other branches +- **Change to the branch you want to update.** +```bash +git checkout name-of-your-rama +``` +- **Take an overflow with the updated `main` branch.** +```bash +git rebase main +``` +- **Upload the changes to your fork.** +```bash +git push origin name-of-your-rama --force +``` + +## 🎯 **Common mistakes** +1. **Local changes without saving.** + - Save changes temporarily + ```bash + git stash + ``` +2. **Then update and recover your changes.** + ```bash + git stash pop + ``` +3. **Untracked files causing conflict.** + - Delete them if you don't need them + ```bash + rm filename + ``` # **📁 Commits** @@ -95,8 +155,15 @@ git commit -m "[fix]: fix bug in code" ``` ```bash -git commit -m "[test]: add test case" +git commit -S -m "[test]: add test case" ``` +**Other Example:** + +- If you wnat to sign your commits, you can use the `-S` flag. + +```bash +git commit -S -m "[refactor]: Changes in the code" +``` # **🔗 Branches** 1. There must be a `main` branch, used only for the releases. diff --git a/README.md b/README.md index 3ca1675..735671a 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,8 @@ CofiBlocks is more than just a coffee marketplace; it's a movement for a more eq - [CofiBlocks: Innovating the Coffee Industry in Costa Rica with Web3](https://mirror.xyz/0xF574753688ABf9740660DFb02E84E4599CA6Eb87/QneFnlPqTRuV_3jt7Kd6foBfFokOKN6zNcJCqpj_xkw) - - - [Pitch Deck](https://docs.google.com/presentation/d/16zPeDC-6fMaCRRpaQCTPPIn_ZKdI0d9ZArkTxd2wmAA/edit#slide=id.p1) + ## 👥 Meet the Team ### ☕ **FOUNDERS** @@ -127,8 +126,8 @@ volumes: 1. Clone the repository: ```bash - git clone https://github.com/Vagabonds-Labs/marketplace.git - cd marketplace + git clone https://github.com/Vagabonds-Labs/cofiblocks.git + cd cofiblocks ``` - Run `docker compose up`, to access the database.