Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.23 KB

GUIDELINES.md

File metadata and controls

28 lines (18 loc) · 1.23 KB

Contribution and Coding Guidelines

Getting Started

  • Understand the Project: Familiarize yourself with the project's inner structure and architecture.
  • Read the Documentation: Ensure you've read any existing documentation to understand how the project works. Comments are significant.

Coding Standards

  • React Best Practices: Adhere to React development best practices, including using functional components and hooks.
  • Code Formatting: Use tools like Prettier for consistent code formatting.
  • Component Structure: Keep components small, reusable, and in separate files and folders. Use CSS modules.
  • Add comments appropriately: Use brief and concise comments when dealing with complex code.

Making Contributions

  • Git and GitHub: Use Git for version control and GitHub for contributions.
  • Issue Tracking: Check the issue tracker before starting work. Create new issues as needed.
  • Commit Messages: Write clear and meaningful commit messages.

Code Reviews

  • Pull Requests: Submit PRs against the main branch for any changes.
  • Peer Review: Be open to feedback and ready to make revisions.

Documentation

  • Update Accordingly: Update documentation to reflect new features or changes.