CONTRIBUTING.md

Hi Hacktobers ready to contribute in Hacktober Fest 2021

Looking to contribute in this repository

Register YourSelf with your GitHub User Id on Hacktober Fest 2021

Welcome Hacktobers 😄

To start contributing, follow these steps 👇:

1. Star ⭐ the repository.
2. Fork 🍴 it.
3. Create Branch 🌿 with your feature <feature>.
4. Push changes.
5. Submit Pull Request 😄 (Mention the Issue Id in the Pull Request).
6. Always follow the style guide (see below).
7. Enjoy contributing 😋.
8. If you have any doubts, open an issue.

Style Guide

Follow this style guide to add your programs:

1. Naming Style: For example if you are demonstrating a string is palindrome or not in C name your file palindromeString.c and save it in the C\Language directory. Always use camel case for naming.

2. Add the following comment header in every program. The comment header should always be at the top of program.

e.g: C/C++/Java
    /*
        Author : Your name
        Date : Date format dd/mm/yyyy
        Description : Description should be small & one liner.
    */
e.g: Python
    """
        Author : Your name
        Date : Date format dd/mm/yyyy
        Description : Description should be small & one liner.
    """

3. Add Opening braces on the same line 1 one space.

int main()
{
                        // ❌.
}

int main() {
                        // ✅.
}

4. Indentation : Use 1 Tab or 4 Spaces. Be consistent with whatever you choose. Use only one indenting format for the whole program.

5. Add appropriate comments wherever necessary to explain the code.

Programs wth NO Comments at all will not be merged.

6. Expression should be readable, Use 1 space between different TOKENS.

hacktober=hacktober+fest          // ❌.
hacktober = hacktober + fest      // ✅.

7. Always add braces in a for/while loop, if, switch case etc., even if it's a one-liner.

for (int i = 0; i < n; i++)
    cout << i << " ";                   // ❌.

for (int i = 0; i < n; i++) {
    cout << i <<" ";                    // ✅.
}

8. * Don't forgot to add new line at the end of your code.

9. You can use online code formatter for
   C/C++.
   Java.
   ⭐ But make sure you meet the above criteria even though you use the formatter.
   If you are using the above formater and static array then the array elements should be like int arr [] = {1, 2, 3, 4, 5}.

Lets Start Now (All the best 👍)