Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 2.43 KB

Contributing Guidelines

We appreciate your interest in contributing to this project! To maintain a high-quality codebase and efficient collaboration, please follow these guidelines:

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top of this repository to create your own fork.

  2. Clone the Repository

    • Clone your fork to your local machine: 
      git clone https://github.com/ElazzouziHassan/ImageEditor.git

  3. Create a Branch

    • Create a new branch for your feature or bug fix: 
      git checkout -b feature/your-feature-name

  4. Commit Changes

    • Make your changes to the codebase. Ensure your code follows the project’s coding standards.
    • After making changes, commit them with a descriptive commit message: 
      git add .
git commit -m "Add feature/fix description"

  5. Push to GitHub

    • Push your branch to GitHub: 
      git push origin feature/your-feature-name

  6. Open a Pull Request

    • Go to the repository on GitHub and open a pull request (PR) from your fork.
    • Provide a detailed description of your changes and link any related issues.

Code Style

  • Ensure your code follows the coding standards defined for this project.
  • For JavaScript/TypeScript:

Commit Messages

  • Follow Conventional Commits for commit messages:
    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation-only changes
    • refactor: Code changes that neither fix a bug nor add a feature
    • test: Adding missing or correcting existing tests

Pull Request Requirements

  • Ensure your PR passes all tests.
  • Include relevant unit tests for new features or bug fixes.
  • Update documentation if necessary.

Reporting Bugs and Issues

  • If you encounter a bug, open an issue on GitHub with as much detail as possible:
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Screenshots (if applicable)

Feature Requests

  • To request a feature, please open an issue on GitHub. Clearly describe the feature and provide context for its value.

Code of Conduct

We appreciate your contributions and thank you for improving the project!