Giter VIP home page Giter VIP logo

agnirath's Introduction

Agnirath

Official Repository of Team Agnirath IITM

Code Guidelines

1. File and Folder Names

  • Use snake_case for all file and folder names.
  • Nest files within folders as much as possible for better organization.

2. Code Documentation

All code should have sufficient comments and documentation.

4. Code Style

Use snake_case for all variable, function, and file names. Ensure all code is properly formatted and adheres to PEP 8 style guide.

5. Folder and File Naming

Name folders and files appropriately to reflect their content and purpose. Organize files in a logical structure as shown in the project structure.

6. Sample Pull Request Format

Title

[Type] [Short description]

Description

Provide a brief description of the changes introduced by this pull request.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Checklist

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

Related Issues

List any related issues or pull requests that this pull request addresses.

7. Sample Commit Message

[type]: [short summary]

[long description]

[Date and time (hh:mm,dd/mm/yy)]

agnirath's People

Contributors

jadevexo avatar bytefoot avatar agnirath-iitm avatar aravind-ramana avatar kailashgopal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.