Contribution Guidelines

Contribution Guidelines

Welcome

Welcome to the Orthogramic Metamodel Wiki! We encourage contributions to enhance and expand the Metamodel, ensuring it remains a valuable resource for business architecture practitioners. This document outlines how you can contribute, propose changes, and participate in discussions.

How to Contribute

You can contribute in several ways:

  • Propose new elements: Suggest additions to the Metamodel, such as new capability elements, value streams, or relationships.

  • Improve definitions: Refine existing descriptions for clarity and precision.

  • Identify inconsistencies: Highlight gaps, overlaps, or inconsistencies in the current Metamodel.

  • Suggest integrations: Recommend how the Metamodel can align with other frameworks or standards.

Contribution Process

Step 1: Review Existing Documentation

Before making a contribution, explore the Metamodel structure to understand existing elements and definitions. You can start with the Metamodel Overview.

Step 2: Submit a Proposal

All contributions should begin with a proposal. To submit:

  1. Create a new wiki page (or update an existing one) outlining your proposal.

  2. Use the proposal template (below) to ensure clarity.

  3. Notify maintainers by tagging them in the discussion section or posting a link in the relevant discussion channel.

Proposal Template

### Proposed Change Describe the addition or modification you are suggesting. ### Rationale Explain why this change is necessary, how it aligns with the Metamodel, and any supporting references. ### Impact Analysis Describe any potential effects on existing structures, relationships, or dependencies. ### Suggested Reviewers List relevant contributors or maintainers for feedback.

Step 3: Participate in Discussion

Once submitted, your proposal will be reviewed by the community and maintainers. Be prepared to discuss and refine your idea based on feedback.

Step 4: Approval & Implementation

  • Minor changes (e.g., typo corrections, small clarifications) may be accepted quickly.

  • Major changes (e.g., new elements, modifications to core structures) require broader discussion and formal approval.

  • Approved changes will be documented in the revision history.

Issue Reporting

If you find an error or inconsistency but are unsure how to fix it, you can report an issue instead:

  1. Create a new wiki page or discussion thread describing the issue.

  2. Provide details, including where the issue is located and any suggested fixes.

  3. Tag relevant maintainers for visibility.

Code of Conduct

To ensure a productive and respectful collaboration environment, all contributors are expected to:

  • Be respectful and professional in discussions.

  • Provide constructive feedback.

  • Follow the principles of open-source contribution and knowledge sharing.

Support & Community

For questions or discussions, please join:

  • Our Slack/Discord community (if available)

  • The Orthogramic forum (if applicable)

  • The Metamodel discussion section in the wiki

The Orthogramic Metamodel license: Creative Commons Attribution-ShareAlike 4.0 (CC BY-SA 4.0), ensuring it remains open, collaborative, and widely accessible.