Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.31 KB

CONVENTIONS.md

File metadata and controls

41 lines (25 loc) · 1.31 KB
Raw

Coding Conventions for Tutorial

This document outlines the coding conventions to be followed when contributing to Tutorial.

1. General Guidelines

  • Write clear and readable code. Use meaningful variable and function names.
  • Follow the language-specific best practices and idioms.

2. HTML/CSS Conventions

  • Use consistent indentation (e.g., 2 or 4 spaces).
  • Prefer double quotes for attribute values in HTML.
  • Use meaningful class and ID names.

3. JavaScript Conventions

  • Follow the JavaScript Standard Style for code formatting.
  • Use const and let appropriately for variable declarations.
  • Avoid global variables when possible.

4. Branch Naming Convention

  • Use hyphens to separate words in branch names.
  • Create branches that are specific and indicative of the changes being made.

5. Commit Message Guidelines

  • Write clear and concise commit messages.
  • Follow the conventional commit format: [GIT_CONVENTIONS.md]

6. Pull Request Guidelines

  • Provide a descriptive title and summary for your pull request.
  • Reference any related issues in the pull request description.

These conventions are in place to maintain consistency and readability across the Tutorial codebase. Please adhere to these guidelines when contributing.

Thank you for your cooperation!

Happy coding!