[Docs] Chapter: Best Practices for Quality and Coverage

[kirti763]

Current State

Desired State

Develop this chapter.

• Draft content can be contributed directly to this Google doc
• Related Meshery Docs:
• Contributing to Meshery CLI
• Contributing to Meshery CLI End-to-End Tests

---

Contributor Guide and Resources

• 📚 Instructions for contributing to layer5-academy
  • academy-template documentation site, example and theme
• 🎨 Wireframes and designs for Layer5 site in Figma (open invite)
• 🙋🏾🙋🏼 Questions: Layer5 Discussion Forum and Layer5 Community Slack

[DHEVIKA]

Hi! I’m a new contributor to the Layer5 community and would like to work on this issue.
Could you please assign it to me?

[Utkarsh-sharma47]

Hi @kirti763 , I'd like to work on this chapter. I'll first review the existing course structure and related Meshery CLI testing documentation, then draft content focused on test quality, coverage strategy, maintainability, and BATS-specific best practices.
If nobody is working on this can I be assigned ?
Thanks.

[Utkarsh-sharma47]

Hi @kirti763 @Bhumikagarggg ,

Quick update: I've completed a first draft for the "Best Practices for Quality and Coverage" chapter in the shared Google document.

The draft currently covers:

• Ensuring quality through reusable helpers, focused tests, and fixtures.
• Effective use of BATS assertions (assert_success, assert_failure, assert_output, and assert_line).
• Regression testing best practices.
• Test coverage strategies, including core functionality, command flags, negative test cases, and real-world workflows.
• Guidance on following existing patterns in the current Meshery CLI end-to-end test suite.

I've based the content on the existing mesheryctl/tests/e2e test suite and the current BATS testing practices used in Meshery. Please let me know if you'd like me to expand or revise any section before it is finalized.

Thanks!