Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs]: Update CONTRIBUTING.md #78

Merged
merged 10 commits into from
Dec 4, 2024
75 changes: 71 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- <a href="https://github.com/Vagabonds-Labs/cofiblocks/pulls" target="_blank"> Summit pull request</a>

# 📌 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
```
#

- <a href="https://github.com/Vagabonds-Labs/cofiblocks/pulls" target="_blank"> Summit pull request</a>
### 🔧 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**

Expand All @@ -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.
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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.
Expand Down
Loading