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

ROADMAP: Improve code statistics and quaility #5504

Open
Samuelopez-ansys opened this issue Nov 29, 2024 · 0 comments
Open

ROADMAP: Improve code statistics and quaility #5504

Samuelopez-ansys opened this issue Nov 29, 2024 · 0 comments
Assignees

Comments

@Samuelopez-ansys
Copy link
Member

Samuelopez-ansys commented Nov 29, 2024

Code Quality Metrics

  • Improve Code Coverage: Increase the percentage of code covered by automated tests (unit, integration, and system tests). Reach 90%.

  • Improve Test: Make tests independent, and make tests dependent on AEDT output.

  • Reduce Cyclomatic Complexity: Break down complex functions into smaller, simpler ones. High complexity can lead to harder-to-maintain code.

  • Refactor duplicated code.

Performance Metrics

  • Optimize Execution Time: Profile the code using tools like cProfile or line_profiler to identify and optimize bottlenecks.

  • Minimize Memory Usage: Use memory profiling tools like memory_profiler to detect inefficient memory usage and optimize data structures.

Maintainability Metrics

  • Reduce Technical Debt: Address warnings, and deprecated functionality

  • Improve Documentation: Ensure that all functions, classes, and modules are well-documented with clear examples. This helps developers understand and extend the codebase.

@Samuelopez-ansys Samuelopez-ansys converted this from a draft issue Nov 29, 2024
@Samuelopez-ansys Samuelopez-ansys added the enhancement New features or code improvements label Nov 29, 2024
@Samuelopez-ansys Samuelopez-ansys moved this to Q2 2025 - Apr-Jun in PyAEDT Public Roadmap Nov 29, 2024
@Samuelopez-ansys Samuelopez-ansys changed the title Improve code statistics Improve code statistics and quaility Nov 29, 2024
@Samuelopez-ansys Samuelopez-ansys changed the title Improve code statistics and quaility ROADMAP: Improve code statistics and quaility Nov 29, 2024
@Samuelopez-ansys Samuelopez-ansys added roadmap and removed enhancement New features or code improvements labels Dec 1, 2024
@Samuelopez-ansys Samuelopez-ansys moved this from Q2 2025 - Apr-Jun to Q3 2025 - Jul-Sept in PyAEDT Public Roadmap Dec 1, 2024
@github-actions github-actions bot removed the roadmap label Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Q3 2025 - Jul-Sept
Development

No branches or pull requests

3 participants