Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (51 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 2.65 KB

Contributing

This is an open-source project, and we welcome contributions from everyone. This guide will help you understand how to contribute.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand what actions will and will not be tolerated.

Reporting Bugs

If you find a bug, please open an issue on GitHub with:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Any relevant logs, screenshots, or error messages

Your First Pull Request

Code Style

Please follow these guidelines to keep the codebase clean and readable:

  • Use meaningful and descriptive names for variables and functions.
  • Keep functions and methods small and focused on a single task.
  • Use comments to explain the purpose of complex code.
  • Follow the existing coding style and conventions used in the project.

Branch Naming Convention

When working on a new feature or task, please follow this branch naming convention before merging in dev branch:

  • Feature Branches:
    Use the prefix feat/ followed by a descriptive name of the feature being developed.
    Examples:

    • feat/login

  • Configuration Branches:
    Use the prefix conf/ for branches that involve configuration changes.
    Examples:

    • conf/firebase

  • Design Branches:
    Use the prefix design/ for design-related changes or improvements.
    Examples:

    • design/login

How to Make a Commit

  1. Commit Header:
    Choose one of the following options based on the type of change made:

    • ADD: For adding new features or files.
    • FIX: For fixing errors or bugs.
    • REFACTOR: For modifying code without changing its functionality.
    • DELETE: For removing code, files, or other entities.
    • DOCS: For changes related to documentation.

  2. Commit Content:
    Inside the parentheses (), specify what was modified in the commit.

  3. Commit Summary:
    After :, provide a brief and clear summary of the change made.

Additional Notes

  • Keep commit messages clear and concise.
  • Use present tense in the summary (Implemented, Fixed, Refactored, Deleted, Documented) to indicate the action taken.
  • Ensure each commit represents a logical and coherent change in the code or documentation.

Thank You!

Your contributions make ColorPlayground better. Thank you for taking the time to contribute!