Talk:03 Coding Standards & Guidelines - Revision history

Artha.kadamb@heinfricke.team at 11:24, 22 December 2025

2025-12-22T11:24:04Z

← Older revision		Revision as of 11:24, 22 December 2025
Line 116:		Line 116:
	* Use automated CI pipelines for running tests.		* Use automated CI pipelines for running tests.

	For more details refer document JUnit_Test_Cases_Document.docx		For more details refer document [[JUnit_Test_Cases_Document.docx]]

	== 9. Documentation ==		== 9. Documentation ==

Artha.kadamb@heinfricke.team at 11:22, 22 December 2025

2025-12-22T11:22:39Z

← Older revision		Revision as of 11:22, 22 December 2025
Line 1:		Line 1:
	== 1 Purpose ==		== 1. Purpose ==
	This document defines the coding standards and guidelines to ensure consistency, readability, maintainability, and quality across all software development projects within the organization.		This document defines the coding standards and guidelines to ensure consistency, readability, maintainability, and quality across all software development projects within the organization.

	== 2 Scope ==		== 2. Scope ==
	These standards apply to all developers, contractors, and third parties who contribute to software development for Hein Fricke.		These standards apply to all developers, contractors, and third parties who contribute to software development for Hein Fricke.

	== 3 General Principles ==		== 3. General Principles ==

	* Code must be clean, consistent, and self-explanatory.		* Code must be clean, consistent, and self-explanatory.
Line 13:		Line 13:
	* Ensure cross-platform and cross-browser compatibility where applicable.		* Ensure cross-platform and cross-browser compatibility where applicable.

	== 4 Coding Conventions ==		== 4. Coding Conventions ==

	=== Naming Conventions ===		=== 4.1 Naming Conventions ===
	{\| class="wikitable"		{\| class="wikitable"
	\|+		\|+
Line 43:		Line 43:
	\|}		\|}

	=== Indentation and Spacing ===		=== 4.2 Indentation and Spacing ===

	* Use 4 spaces per indentation level (no tabs).		* Use 4 spaces per indentation level (no tabs).
Line 49:		Line 49:
	* Leave a blank line between method definitions.		* Leave a blank line between method definitions.

	=== Line Length ===		=== 4.3 Line Length ===

	* Maximum of 120 characters per line.		* Maximum of 120 characters per line.

	=== File Structure ===		=== 4.4 File Structure ===

	* One class/component per file.		* One class/component per file.
Line 59:		Line 59:
	* Group logically related functions and classes.		* Group logically related functions and classes.

	== 5 Language-Specific Standards ==		== 5. Language-Specific Standards ==

	=== JavaScript/TypeScript ===		=== 5.1 JavaScript/TypeScript ===

	* Use `const` and `let`, avoid `var`.		* Use `const` and `let`, avoid `var`.
Line 68:		Line 68:
	* Use ES6+ syntax.		* Use ES6+ syntax.

	=== Python ===		=== 5.2 Python ===

	* Follow PEP8 standards.		* Follow PEP8 standards.
Line 74:		Line 74:
	* Document functions with docstrings.		* Document functions with docstrings.

	=== Java ===		=== 5.3 Java ===

	* Follow Oracle Java Code Conventions.		* Follow Oracle Java Code Conventions.
Line 80:		Line 80:
	* Use appropriate access modifiers.		* Use appropriate access modifiers.

	=== HTML/CSS ===		=== 5.4 HTML/CSS ===

	* Use semantic HTML tags.		* Use semantic HTML tags.
Line 86:		Line 86:
	* Use BEM naming for CSS classes.		* Use BEM naming for CSS classes.

	== 6 Version Control ==		== 6. Version Control ==
	~~Use Git for source control.~~

	Commit messages should be clear and follow the format:		* Use Git for source control.
			* Commit messages should be clear and follow the format:

	<type>: <short description>		<blockquote><type>: <short description>

	[optional body]		[optional body]

	[optional footer]		[optional footer] </blockquote>

	Common commit types: feat, fix, docs, style, refactor, test, chore.		* Common commit types: feat, fix, docs, style, refactor, test, chore.

	== 7 Code Review ==		== 7. Code Review ==

	* All code must be reviewed via pull requests.		* All code must be reviewed via pull requests.
Line 109:		Line 109:
	** Security and performance issues		** Security and performance issues

	== 8 Testing ==		== 8. Testing ==

	* Write unit tests for all functions/methods.		* Write unit tests for all functions/methods.
Line 118:		Line 118:
	For more details refer document JUnit_Test_Cases_Document.docx		For more details refer document JUnit_Test_Cases_Document.docx

	== 9 Documentation ==		== 9. Documentation ==

	* All public APIs, classes, and modules must be documented.		* All public APIs, classes, and modules must be documented.
Line 127:		Line 127:
	** Usage examples		** Usage examples

	== 10 Security Practices ==		== 10. Security Practices ==

	* Validate all user input.		* Validate all user input.

Artha.kadamb@heinfricke.team: /* 12. References */

2025-12-22T09:59:38Z

12. References

← Older revision		Revision as of 09:59, 22 December 2025
Line 142:		Line 142:
	== 12. References ==		== 12. References ==

	* PEP8 - Python Style Guide: ~~<nowiki>~~https://peps.python.org/pep-0008/~~</nowiki>~~		* PEP8 - Python Style Guide: https://peps.python.org/pep-0008/
	* Google Java Style Guide: ~~<nowiki>~~https://google.github.io/styleguide/javaguide.html~~</nowiki>~~		* Google Java Style Guide: https://google.github.io/styleguide/javaguide.html
	* Airbnb JavaScript Style Guide: ~~<nowiki>~~https://github.com/airbnb/javascript~~</nowiki>~~		* Airbnb JavaScript Style Guide: https://github.com/airbnb/javascript

Artha.kadamb@heinfricke.team: /* 8 Testing */

2025-12-22T09:58:07Z

8 Testing

← Older revision		Revision as of 09:58, 22 December 2025
Line 116:		Line 116:
	* Use automated CI pipelines for running tests.		* Use automated CI pipelines for running tests.

	For more details ~~are mentioned in~~ JUnit_Test_Cases_Document.docx ~~document~~		For more details refer document JUnit_Test_Cases_Document.docx

	== 9 Documentation ==		== 9 Documentation ==

Artha.kadamb@heinfricke.team: /* 3 General Principles */

2025-12-22T09:57:18Z

3 General Principles

← Older revision		Revision as of 09:57, 22 December 2025
Line 6:		Line 6:

	== 3 General Principles ==		== 3 General Principles ==
	~~Code must be clean, consistent, and self-explanatory.~~

	Follow the DRY (Don't Repeat Yourself) principle.		* Code must be clean, consistent, and self-explanatory.
			* Follow the DRY (Don't Repeat Yourself) principle.
	Optimize for readability over cleverness.		* Optimize for readability over cleverness.
			* Include meaningful comments where necessary.
	Include meaningful comments where necessary.		* Ensure cross-platform and cross-browser compatibility where applicable.

	Ensure cross-platform and cross-browser compatibility where applicable.

	== 4 Coding Conventions ==		== 4 Coding Conventions ==

Artha.kadamb@heinfricke.team: /* Coding Conventions */

2025-12-22T09:56:44Z

Coding Conventions

Show changes

Artha.kadamb@heinfricke.team: Created page with "== Purpose == This document defines the coding standards and guidelines to ensure consistency, readability, maintainability, and quality across all software development projects within the organization. == Scope == These standards apply to all developers, contractors, and third parties who contribute to software development for Hein Fricke. == General Principles == Code must be clean, consistent, and self-explanatory. Follow the DRY (Don't Repeat Yourself) principle..."

2025-12-22T09:31:18Z

Created page with "== Purpose == This document defines the coding standards and guidelines to ensure consistency, readability, maintainability, and quality across all software development projects within the organization. == Scope == These standards apply to all developers, contractors, and third parties who contribute to software development for Hein Fricke. == General Principles == Code must be clean, consistent, and self-explanatory. Follow the DRY (Don't Repeat Yourself) principle..."

New page

== Purpose ==
This document defines the coding standards and guidelines to ensure consistency, readability, maintainability, and quality across all software development projects within the organization.

== Scope ==
These standards apply to all developers, contractors, and third parties who contribute to software development for Hein Fricke.

== General Principles ==
Code must be clean, consistent, and self-explanatory.

Follow the DRY (Don't Repeat Yourself) principle.

Optimize for readability over cleverness.

Include meaningful comments where necessary.

Ensure cross-platform and cross-browser compatibility where applicable.

== Coding Conventions ==