Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

127 lines (86 loc) · 3.31 KB

Contributing to Complete-Preparation

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

🚀 Let's get started!

Follow the steps to contribute to Complete-Preparation.

1. Fork Complete-Preparation repository.

2. Clone your forked copy of the project.

$ git clone https://github.com/<your_gihub_username>/Complete-Preparation.git

3. Checkout into a new branch

$ git checkout -b <branch_name>

4. Make your changes to it

5. Add and commit your changes

$ git add . && git commit -m "<your_message>"

6. Push Code to Github under your branch

$ git push origin <branch_name>

📌 Update Your Github Forked Repository

1. Lists the remote connections

$ git remote -v

2. Adding the remote repository (only first time)

$ git remote add upstream https://github.com/chetan6780/Complete-Preparation

3. Fetching The Upstream Repository

$ git fetch upstream

4. Finally Merging with Upstream Repository

$ git merge upstream/master

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when creating new file/folder
    • ✨ :sparkles: or 🚀 :rocket: when updating existing file/folder
    • 📘 :blue_book: when writing docs
    • 🔥 :fire: when deleting code or files
    • ✅ :white_check_mark: when completing something.
    • 💯 :100: when completed adding full youtube playlist code
    • 🥲 :smiling_face_with_tear: only for gitignore file
  • Example: 🎨 Create contributing.md
  • Above imojis are not mandatory, you can use any meaningful imoji you want.

C++ Style Guide

  • All C++ code is linted/formatted with Prettier.
  • write cpp code only in below format (ignore |): 
    | ```cpp
|   // Write your code here...
| ```

Java Style Guide

I had plan to add java code too but due to lack of time I am not able to add it. If you want to contribute in java, please follow below style guide.

  • Create a folder for only java code in same directory where cpp code is present.
  • All Java code is linted/formatted with Prettier.
  • write java code only in below format (ignore |): 
    | ```java
|   // Write your code here...
| ```

Documentation Style Guide

  • write proper explanation for your code.
  • write as many approaches as you can from brute force to highly optimized.
  • Include credit links.

📌 Must steps before creating PR

Make sure to check following boxes, and include them in your PR description.

  • Add the relative link in respective README file with proper indentation.
  • Add the relative link in SUMMARY.md file present in root directory with proper indentation.

🚫 Don'ts

  • Don't rearrange existing folders/files structure, you can add new folders/files.

Finally, thank you for your interest in contributing to Complete-Preparation! ❤️