Skip to content

best-practices.md

Latest commit

 

History

History
76 lines (53 loc) · 3.03 KB

best-practices.md

File metadata and controls

76 lines (53 loc) · 3.03 KB

Best Practices for UniPath.io Development

This document outlines best practices for developers contributing to UniPath.io, a project designed with Next.js, Material-UI, and AWS Amplify.

Table of Contents

Code Style and Quality

  • Follow the Airbnb JavaScript Style Guide.
  • Use ESLint and Prettier to enforce code style and quality.
  • Ensure code is clean, well-commented, and easy to maintain.

Commit Message Guidelines

  • Follow the Conventional Commits specification.
  • Include meaningful commit messages that explain the changes and why they were made.

Code Reviews

  • Submit Pull Requests for code reviews, and ensure at least one other developer reviews your code before merging.
  • Address all feedback and ensure all automated checks pass before merging.

Testing and Coverage

  • Write unit and integration tests using Jest and React Testing Library.
  • Strive for a high level of code coverage, and ensure no regressions are introduced.

Documentation

  • Document code inline using JSDoc-style comments.
  • Update README and other documentation files as necessary to reflect changes in the codebase or setup instructions.

Dependency Management

  • Keep dependencies up-to-date, and follow semantic versioning.
  • Review and understand the licenses of all dependencies to ensure they are compatible with this project's license.

Error Handling

  • Handle errors gracefully, providing helpful error messages and logging errors as necessary.
  • Use custom error classes to differentiate between different types of errors.

Accessibility

  • Follow the WCAG guidelines to ensure the application is accessible.
  • Use semantic HTML and ARIA roles to improve accessibility.

Performance Optimization

  • Optimize images and other assets to reduce load times.
  • Use Next.js's built-in image optimization and lazy loading features.

These best practices are aimed at ensuring a high level of code quality and consistency across the UniPath.io codebase, making it easier for developers to contribute and collaborate.

(back to top)