Skip to content

Home

Jump to bottom
Sharafat edited this page Jun 1, 2023 · 1 revision

Contribution Guide

Welcome to our project! We sincerely appreciate your interest in contributing. This guide will help you understand how you can contribute your solutions to the project.

Getting Started

  1. Fork the repository to your GitHub account by clicking the Fork button at the top right corner of the repository page.
  2. Clone the forked repository to your local machine using the following command:
git clone https://github.com/your-username/project.git
  1. Navigate to the project directory:
cd project

Folder Structure

The project follows a specific folder structure to organize the contributions. Please ensure you follow the structure outlined below:

solutions # Root folder
name # Your Name
├── 1 # Chapter 1 solutions
│ ├── 1.c # Exercise 1.1 solutions
│ ├── 2.c # Exercise 1.2 solutions
│ └── ... # Other exercises
├── 2 # Chapter 2 solutions
│ ├── 1.c # Exercise 2.1 solutions
│ ├── 2.c # Exercise 2.2 solutions
│ └── ... # Other exercises
└── ... # Other chapters

Ensure that you create a folder with your name inside the solutions directory. Inside your folder, create subdirectories for each chapter, and place your solution files in the respective exercise directories.

Contributing

  1. Create a new branch for your contributions:
git checkout -b your-branch-name

  1. Write your code for the exercise and save it in the appropriate exercise directory under your name folder.

  2. Commit your changes with a descriptive commit message:

git commit -m "Add solution for Chapter X, Exercise Y"
  1. Push the changes to your forked repository:
git push origin your-branch-name

  1. Open a Pull Request from your branch to the main project repository. Provide a clear title and description for your contribution.

  2. Congratulations! You have successfully submitted your contribution. Our team will review your code, provide feedback if necessary, and merge it into the main project.

Guidelines

  • Follow good coding practices and maintain a clean and readable code style.
  • Ensure your solutions are working correctly and provide any necessary explanations or documentation.
  • Do not include any personal or sensitive information in your code or file names.

Thank you for your valuable contribution! We appreciate your effort in making this project better.

Feel free to customize and modify this template to suit your project's specific needs and guidelines.

Clone this wiki locally