Development Guidelines Documentation

[EmKaaaM]

Development Guidelines Documentation Checklist:

Coding Standards:

• Language Consistency: Ensure all code is written in Java and follows standard Java conventions.
• Code Formatting: Define guidelines for spacing, indentation, and brackets.
  • Example: Use 4 spaces for indentation, not tabs.
• Naming Conventions: Specify how variables, functions, classes, etc. should be named.
  • Example: Use camelCase for variable names, PascalCase for class names.
• Comments: Provide standards for inline and block comments.
  • Example: Use Javadoc-style comments for functions and classes.
• Error Handling: Define how errors should be handled and logged.
• Function/Method Size: Set a limit on the length or complexity of methods to maintain readability.
• Code Reusability: Encourage the use of modular and reusable code.
• Dependency Management: Specify how to add and manage libraries or frameworks.
• Deprecated Code: Set guidelines for managing and updating deprecated or obsolete code sections.

Branching Strategies:

• Main Branch: Define the main branch's purpose (typically production-ready code).
• Development/Branch Naming: Specify naming conventions for branches.
  • Example: feature/feature-name, bugfix/bug-description, etc.
• Feature Branching: Explain when and how to create a feature branch.
• Bugfix Branching: Explain when and how to create a bugfix branch.
• Commit Messages: Set standards for clear, concise commit messages.
  • Example: "Fix login bug" instead of "Fixed some issues."
• Merging to Main: Specify criteria that must be met before merging to the main branch (like code reviews, passing tests, etc.).

Merge Request Guidelines:

• Merge Request (MR) Title: Define a clear format for MR titles.
• Description: Explain the necessity of detailed descriptions in MRs, detailing what changes were made and why.
• Linking Issues: Encourage linking related issues to the MR for better tracking.
• Code Review: Specify who should review MRs and the criteria for approval.
• Continuous Integration (CI): Define CI checks that should pass before merging.
• Merge Conflicts: Provide guidelines on resolving merge conflicts.
• Post-Merge Testing: Encourage testing the application post-merge to ensure everything works as expected.

This is just an initial list of things that we need to document and complete.

Please check the box once that item or part has been documented.