Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

suggestion: refactor testing docs for improved clarity and organization #3180

Open
omermorad opened this issue Jan 16, 2025 · 0 comments
Open

Comments

@omermorad
Copy link
Contributor

Overview

The current testing documentation offers a strong starting point for developers looking to test their NestJS applications. However, with the introduction of new tools and methodologies - the landscape has grown more complex. This evolution has resulted in a degree of fragmentation within the documentation, which can make it harder for some users, particularly those new to testing or to NestJS, to understand the full range of best practices and testing approaches available to them. A more cohesive and structured presentation could greatly improve the developer experience, ensuring that users of all levels can confidently adopt modern testing strategies while maintaining robust, maintainable codebases.

I propose a structured refactor of the testing documentation to:

  • Consolidate related topics into a cohesive structure.
  • Highlight modern tools and methodologies.
  • Clearly distinguish between testing types (e.g., unit, integration, and e2e testing).
  • Provide practical, well-organized examples for each testing approach.

Motivation

A refactor would enhance the understanding of the roles and advantages of various testing methodologies, such as solitary, sociable, broad and narrow integration, and end-to-end testing. This will showcase the implementation of these approaches in NestJS, including examples that address dependency injection, mocking, and configuration testing.

Aligning the documentation with established theories and best practices in software testing, such as those from Martin Fowler, will help us create more robust and maintainable codebases.

I would be glad to elaborate on this concept and provide a suggested table of contents if that sounds appealing to you 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant