Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

87 lines (62 loc) · 2.52 KB

Contributing to CNAMM

Thank you for your interest in contributing to the Cloud Native Assurance Maturity Model (CNAMM)! We welcome contributions from the community to help improve and evolve this framework.

Ways to Contribute

Framework Enhancement

  • Suggest improvements to assessment criteria
  • Propose new practice areas or measurement approaches
  • Share industry-specific adaptations
  • Provide feedback on scoring methodologies
  • Recommend updates to maturity level definitions

Documentation

  • Improve existing documentation clarity
  • Add implementation examples and case studies
  • Create guides for specific industries or use cases
  • Translate documentation to other languages
  • Fix typos or formatting issues

Assessment Toolkit

  • Suggest improvements to the Excel assessment tool
  • Report calculation or formula issues
  • Propose new visualization approaches
  • Share templates for common tasks
  • Recommend usability enhancements

Community Building

  • Share your implementation experiences
  • Present at community meetings
  • Write blog posts or articles
  • Mentor new adopters
  • Answer questions in discussions

Contribution Process

  1. Start a Discussion

    • Open an issue to discuss your proposed changes
    • Share your ideas in community meetings
    • Get feedback from maintainers and other contributors

  2. Make Your Changes

    • Fork the repository
    • Create a branch for your changes
    • Make your updates to documentation or toolkit files
    • Ensure all changes are well-documented

  3. Submit Changes

    • Create a pull request with a clear description
    • Reference any related issues
    • Include before/after examples if applicable
    • Be ready to discuss and refine your changes

Documentation Guidelines

  • Use clear, concise language
  • Include practical examples
  • Follow existing formatting
  • Link to related resources
  • Update table of contents when needed

Community Channels

  • GitHub Discussions: Technical discussions and questions
  • Mailing List: Community announcements
  • Community Meetings: Monthly virtual meetings
  • Issue Tracker: Bug reports and feature requests

Recognition

All contributors will be acknowledged in our releases and documentation. Significant contributors may be invited to join as project maintainers.

Questions?

If you have any questions about contributing, please:

License

By contributing to CNAMM, you agree that your contributions will be licensed under the CC BY-SA 4.0 License.