Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (36 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 2.12 KB

Contributing to Web Rating

Thank you for considering contributing to Web Rating! We appreciate your interest in helping us improve this project.

Getting Started

Before you start contributing, please make sure you have read and understood the following:

  • README.md: Understand the purpose and functionality of Web Rating.
  • LICENSE: Familiarize yourself with the licensing terms of the project.

Contribution Guidelines

Issues

  • Before creating a new issue, please search existing issues to ensure that your issue is not already reported.
  • When creating a new issue, provide as much detail as possible, including:
    • A clear and concise description of the issue.
    • Steps to reproduce the issue.
    • Any relevant error messages or logs.

Pull Requests

  • All pull requests should be submitted against the main branch.
  • When creating a pull request, please provide:
    • A clear and concise description of the changes made.
    • A detailed explanation of the reasoning behind the changes.
    • Any relevant screenshots or examples.
  • Ensure that your code is formatted according to the project's coding standards.
  • Make sure to include any necessary tests for your changes.

Code Style

  • We use the Angular Style Guide as a reference for our coding standards.
  • Use consistent naming conventions and formatting throughout your code.

Commit Messages

  • Use the Conventional Commits format for your commit messages.
  • Keep your commit messages concise and descriptive.

Development Environment

  • Make sure you have Node.js (21 or higher) and npm installed on your machine.
  • Run pnpm install to install all dependencies.
  • Use ng serve to start the development server.

Code Review

  • All pull requests will be reviewed by the maintainers of the project.
  • We will provide feedback on your changes and may request modifications before merging.

Thank You

Thank you again for considering contributing to Web Rating! We look forward to reviewing your pull requests and working together to improve this project.