Conventions in OneCX

  • Consistent paths, naming conventions, and shared UI patterns ease integration.

  • Prefer reusable libraries from onecx-portal-ui-libs.

  • Testing guidelines help ensure quality and reliability.

  • Documentation standards maintain clarity and uniformity across the platform.

  • Coding standards promote best practices and maintainability.

  • Use established design patterns for scalability and performance.

  • Follow versioning strategies for effective release management.

  • Leverage CI/CD pipelines for automated testing and deployment.

  • Adhere to security best practices to protect data and services.

  • Utilize logging and monitoring for operational insights and troubleshooting.

  • Engage with the community for support, contributions, and knowledge sharing.

  • Keep documentation up to date with code changes and new features.

  • Use consistent terminology to avoid confusion.

  • Follow UI/UX guidelines for a cohesive user experience.

  • Implement localization and internationalization where applicable.

  • Document APIs with clear specifications and examples.

  • Use containerization for consistent development and deployment environments.

  • Apply infrastructure as code principles for environment management.

  • Regularly review and refactor code to improve quality and performance.

  • Participate in code reviews to maintain standards and share knowledge.

  • Stay informed about updates and changes in the OneCX platform.

  • Utilize shared components and services to reduce duplication.

  • Follow branching strategies for effective source control management.

  • Use automated tools for code quality checks and testing.

  • Document setup and configuration steps for easy onboarding.