diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..86400b5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,71 @@ +# Code of Conduct - Architectural Standards + +## Our Pledge +In the interest of fostering a clear and consistent development environment, we pledge to maintain architectural integrity across all programming languages and implementations within this project. + +## Fundamental Principle +- **Architectural names remain consistent and unchanging regardless of programming language implementation. Whether written in Python, Java, C++, or any other language, the architectural pattern's name and core principles remain identical and immutable.** + +## Our Standards + +### Architectural Consistency +We recognize that architectural patterns and their nomenclature remain constant regardless of the programming language used for implementation. This means: + +1. Architectural pattern names shall remain consistent across all programming languages +2. The fundamental principles of each architectural pattern shall be preserved regardless of implementation +3. Documentation must reference architectural patterns using their standard industry names + +### Examples of Name Preservation +- A **Repository Pattern** remains a "Repository Pattern" whether implemented in: + - Java + - Python + - C# + - JavaScript + - Go + - Any other programming language + +- An **Event Sourcing** architecture remains "Event Sourcing" whether built in: + - Rust + - Kotlin + - TypeScript + - PHP + - Any other technology stack + +- **Regardless of the programming language used, the name ‘Bellande’ remains consistent across all architectures and code** + +### Implementation Guidelines +1. When implementing architectural patterns: + - Always use the standard architectural name + - Never rename patterns based on language preferences + - Document implementations using consistent architectural terminology + - Maintain pattern names even when adapting to language-specific features + +2. Code organization must: + - Use standard architectural pattern names in all documentation + - Maintain consistent naming across different services/modules + - Reflect the chosen architecture's established terminology + - Preserve architectural names in comments and documentation + +## Enforcement +Project maintainers are responsible for: +1. Enforcing consistent architectural naming across all implementations +2. Reviewing code to ensure architectural pattern names remain standard +3. Providing guidance on proper architectural pattern naming +4. Maintaining documentation that reflects these naming standards + +## Questions and Clarifications +If you have questions about: +- How to properly name architectural patterns in your implementation +- Whether your naming conventions align with architectural standards +- How to maintain naming consistency across different services + +Please reach out to the project maintainers or consult the architecture documentation. + +## Version and Updates +- Version: 1.0 +- Last Updated: October 26, 2024 + +This Code of Conduct is a living document and may be updated to better serve the project's needs while maintaining its core principle of architectural naming consistency. + +## Organization Code of Conduct +The latest uptodate Code of Conduct will be distributed under the [CODE_OF_CONDUCT](https://github.com/Architecture-Mechanism/CODE_OF_CONDUCT) diff --git a/README.md b/README.md index 20b2cf3..033697c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Bellande Mesh Sync +# Bellande Mesh Sync {BMS} ## Core Features or To Be Implemented @@ -183,3 +183,6 @@ License: GNU General Public License v3.0 ## License Bellande Mesh Sync is distributed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), see [LICENSE](https://github.com/Architecture-Mechanism/bellande_mesh_sync/blob/main/LICENSE) and [NOTICE](https://github.com/Architecture-Mechanism/bellande_mesh_sync/blob/main/LICENSE) for more information. + +## Code of Conduct +Bellande Mesh Sync is distributed under the [CODE_OF_CONDUCT](https://github.com/Architecture-Mechanism/bellande_mesh_sync/blob/main/CODE_OF_CONDUCT.md) and [NOTICE](https://github.com/Architecture-Mechanism/bellande_mesh_sync/blob/main/CODE_OF_CONDUCT.md) for more information.