Docs/readme

CONTRIBUTING.md

@@ -1,81 +1,116 @@
-# ☕ Contributing to CofiBlocks
+# **CONTRIBUTING GUIDE BY COFIBLOCKS** ☕
 
-Thank you for your interest in contributing to **CofiBlocks**! This document outlines the steps to get started, guidelines for contributions, and how to collaborate effectively with the team.
+Thank you for your interest in contributing to CofiBlocks! We appreciate your time and effort in making our project better.
 
----
+This guide will help you get started with contributing to our project. Please note that we have a code of conduct, which we expect all contributors to adhere to.
 
-## 🚀 Contribution Guideline
+## 📝 **Contributing**
 
-### Getting Started
-- 🔍 Visit the [Issues](https://github.com/Vagabonds-Labs/cofiblocks/issues) tab to see ongoing work or feature requests
-- 💬 If you find an issue that interests you, comment to express your interest
-- 📝 For new ideas, create a detailed issue with clear descriptions
+We welcome contributions from the community! Here's how you can help:
 
-### Creating New Issues
-- 🐛 For bugs, include steps to reproduce
-- ✨ For features, describe the enhancement clearly
+1. **Clone and Fork Repo**: Click the **Fork** button in the top-right corner to create a copy of the repository under your account.
 
-### Start Working
-  - Once an issue is assigned to you, proceed with the technical steps described below.
+    - <a href="https://github.com/Vagabonds-Labs/cofiblocks" target="_blank"> HERE</a>
 
----
+#
 
-## 🛠 How To Contribute
+2. **Clone the Fork:** 
+    - Clone the forked repository to your local machine by running the following command:
 
-1. Fork the repository to your GitHub account first.
+    ```bash
+   git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
+   ```
 
-2. Clone the repository in your local machine:
-```bash
-git clone https://github.com/YOUR_USERNAME/cofiblocks.git
-cd marketplace
-```
+    - Replace `YOUR_USERNAME` and `REPOSITORY_NAME` with your GitHub username and the repository name.
 
-2. Create and switch to your branch: 
-```bash
-git checkout -b feature/amazing-feature 
-```
+#
 
-3. Make changes:
-Make your changes. Ensure your code adheres to the project's coding style and standards.
+3. **Create a new branch or use the main branch:** When modifying contracts kindly make sure the formatting is correct and all tests pass successfully.
 
-4. Add and commit your changes:
-```bash
-git add .
-git commit -m "Add amazing feature"
-```
+    - Create a branch name based on the type of change (e.g., `feat/name-related-issue`, `docs/name-related-issue`).
 
-5. Push to the branch:
-```bash
-git push origin feature/amazing-feature
-```
+    ```
+    git checkout -b branch-name
+    ```
+    - One of ideas on how to implement it for the branch name:
+
+        > `docs/update-readme` or `fix/bottom-bug`.
+
+#
+
+4. **Commit:** Commit your changes.
+
+    1. **git add (file-name)**
+    2. **git commit -m "[type] description"**
 
-6. Open a Pull Request.
-Once your changes are ready, submit a Pull Request for review. Ensure that:
+    - Example: 
+    ```
+    git add Create_Documentation
 
-Ensure your PR has a clear title, a detailed description of the changes, and references any related issues (if applicable).
+    git commit -m "[docs]: update documentation"
+    ```
 
-All contributions go through the PR review process to maintain code quality. After review, maintainers will provide feedback or merge it into the main branch.
+#
 
----
+5. **Push fork:** Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
 
-## Code of Conduct
+- Push your changes to your forked repository:
+    ```bash
+   git push origin your-branch-name
+   ```
+   > Replace `your-branch-name` with the name of your branch.
 
-We are committed to creating a welcoming and inclusive environment. Please read our [Community Guidelines](COMMUNITY_GUIDELINES.md) to ensure a positive experience for everyone involved.
+- Example: 
 
----
+    ```bash
+    git push origin fix/bug-fix
+    ```
 
-## 🌐 Community Resources
+#
 
-Stay connected with the **CofiBlocks** community! Here are the resources where you can engage, stay informed, and collaborate with the team and other contributors:
+6. **Submit a Pull Request:** Submit a pull request to the `main` branch of the Semaphore Stellar SDK repository.
 
-- **Twitter**  
-  Follow us on [Twitter](https://x.com/cofiblocks) 
+    - <a href="https://github.com/Vagabonds-Labs/cofiblocks/pulls" target="_blank"> Summit pull request</a>
 
-- **Website**  
-  Visit our [Official Website](https://www.cofiblocks.com/) 
+# **📁 Commits**
 
-We look forward to your active participation and contributions! 🚀
+You can do a regular commit by following the next:
 
+``` [type] significant message ```
 
+- <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank">Learn more about conventional commits</a>
 
+### Type
 
+Add changes you worked on the issue.
+
+**Examples:**
+
+```bash
+git commit -m "[docs]: update documentation"
+``` 
+
+```bash
+git commit -m "[fix]: fix bug in code"
+``` 
+
+```bash
+git commit -m "[test]: add test case"
+```
+
+# **🔗 Branches**
+1. There must be a `main` branch, used only for the releases.
+2. Avoid long descriptive names for long-lived branches.
+3. Use kebab-case (no CamelCase).
+4. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
+5. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
+6. Use slashes to separate parts of your branch names.
+7. Remove your branch after merging it if it is not important.
+**Examples:**
+```
+git branch -b docs/readme
+git branch -b test/a-feature
+git branch -b feat/sidebar
+git branch -b fix/b-feature
+```
+#