Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 2.61 KB

DOCUMENT_GUIDE.md

File metadata and controls

64 lines (49 loc) · 2.61 KB

Development Guide

Coding Conventions

Language

  • Use British English in your code, comments, and documentation.

Indentation

  • Use 2 spaces for indentation.
  • Ensure consistent indentation style across the project.

Line Endings

  • Use LF (Line Feed) line endings.

Trailing Whitespace

  • Remove trailing whitespace from your code files.
  • Exception: In Markdown files, you can leave trailing whitespace for better control of line breaks.

Recommended Extensions

  • The following Visual Studio Code extensions are recommended for this project:
    • Prettier: For code formatting.
    • ESLint: For code linting and static analysis.
    • EditorConfig: To maintain consistent coding style across different editors.

Setting up Your Development Environment

  1. Clone the project repository from GitHub.
  2. Install Node.js and npm if not already installed.
  3. Install Visual Studio Code if not already installed.
  4. Install the recommended extensions:
    • Prettier
    • ESLint
    • EditorConfig
  5. Open the project folder in Visual Studio Code.
  6. Ensure that the .editorconfig file and workspace-specific settings in .vscode/settings.json are being respected by your editor.

Version Control

  • Use Git for version control.
  • Follow Git best practices, including meaningful commit messages and branching strategies.
  • Keep the .editorconfig, .vscode/settings.json, and other configuration files under version control to maintain consistency across the team.

Documentation

  • Keep project documentation up to date in the docs/ directory.
  • Use Markdown for documentation.
  • Document code changes, project structure, and usage instructions for developers and users.

Code Reviews

  • Before merging code, ensure it adheres to the coding conventions and passes linting and formatting checks.
  • Conduct code reviews to maintain code quality and consistency.

Testing

  • Write unit tests and integration tests for your code.
  • Ensure that tests are passing before merging code changes.

Security

  • Follow security best practices to protect the project and its users.

Licensing

  • Check the project's licensing terms and ensure compliance with open-source licenses.

Support and Contacts

  • For questions or assistance, contact [Your Contact Person].

Disclaimer

  • This guide is for illustrative purposes and should be customized to match the specific requirements of your organization or project.