Documentation Guidelines.

You need to follow the under mentioned format while adding your work in your respective guideline.

Adding Code

• Push your code / Upload your code in the correct format with the correct extension. (If you are having any dataset which is more than 25MB then you can create a drive link and mention in the README.)
• Your code must have comments in the important part explaining that work so that it will be easy for the reviewer to know about the code/work.
• If you are uploading Jupyter Notebook, make sure that it is in .ipynb format.
• If you are uploading an APK, make sure that you make a pre-release in the release section.
• If you are uploading an Arduino code, make sure that the .ino the file is inside a single folder under the same title as of the .ino 's the file name.
• For any issue, you can create an issue under the issue section under the label HELP WANTED.

Adding README

• Make sure that you explain well about your work in the README section.
• You can follow our other repositories for reference.
• README is in MARKDOWN format if you don't know how to write in Markdown format, then here's a guide: Click here
• You can add images/flow diagrams/ circuit diagrams to explain your piece of work.
• For any issue, you can create an issue under the issue section under the label HELP WANTED.

Saswat Samal
Team Head
PIYSocial