GitHub Contribution Guide For Metis Cipher Session Q1 2025

Here you'll find the Github and Smart Contract activities of the students who joined the B<>rder/ess <> Metis Cipher Session in January 2025

---

Step-by-Step Contribution Guide

Welcome to our 3-month training program! In this guide, you'll learn how to contribute your weekly projects to the training repository. Follow these steps carefully to ensure your projects are properly added.

1. Fork the Repository

Start by forking the Metis-Cipher-Session-Q1-2025 repository to your GitHub account. This creates a personal copy of the repository where you can make changes without affecting the original.

• Go to the repository page: (Metis-Cipher-Session-Q1-2025)[https://github.com/B-rder-ess-Dev-Hub/Metis-Cipher-Session-Q1-2025].

• Click the Fork button at the top-right corner of the page.

2. Clone the Forked Repository

Clone the repository you just forked to your local machine:

git clone https://github.com/<your_username>//Metis-Cipher-Session-Q1-2025.git
cd Metis-Cipher-Session-Q1-2025

3. Navigate to the Weekly Project Folder

Each week has a designated project folder inside the repository. Navigate to the folder for the current week (e.g., week-1-projects, week-2-projects):

cd week-<week_number>-projects

Example:

cd week-1-projects

4. Create Your Folder

Inside the weekly folder, create a new folder named after your first name or a unique identifier (e.g., john, jane-doe):

mkdir <your_name>

Example:

mkdir john

5. Add Your Project Files

Place all the files related to your project (code, documentation, assets, etc.) into your folder. Ensure your files are organized and well-documented.

6. Commit Your Changes

Stage and commit your changes with a clear and descriptive commit message:

git add .
git commit -m "Add Week <week_number> project for <your_name>"

Example:

git commit -m "Add Week 1 project for John Doe"

7. Push Your Changes

Push your changes to the remote repository. If you're on a new branch, use the branch name matching your changes (e.g., week-1-john-project):

git push origin <your_branch_name>

Example:

git push origin week-1-john-project

8. Create a Pull Request

1. Go to the original GitHub repository in your browser: (Metis-Cipher-Session-Q1-2025)[https://github.com/B-rder-ess-Dev-Hub/Metis-Cipher-Session-Q1-2025].

2. Click on the Pull Requests tab.

3. Click New Pull Request and select "Compare across forks" if needed.

4. Select your forked repository and branch as the source, and the main branch of the original repository as the destination.

5. Provide a descriptive title and include details about your project in the description.

Example PR Title:

Add Week 1 Project for John Doe

9. Wait for Review

The repository maintainers will review your pull request. Address any feedback promptly and resubmit if needed.

---

Additional Notes

• Ensure your project is complete, well-documented, and functional before submitting.

• Follow the repository's coding and folder structure guidelines.

• Create a new folder each week and place all files and assets related to that week's project in the folder.

• If you encounter any issues, contact your training facilitator for help.

Thank you for contributing to our training repository! Happy coding!