initial commit

Author: muhammad-fiaz

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to `image-optimize-cli`
+
+Thank you for your interest in contributing to `image-optimize-cli`! We welcome contributions of all types, from bug fixes and features to documentation improvements. Please follow these guidelines to help us maintain a high-quality project.
+
+## Getting Started
+
+1. **Fork the Repository**: Click the "Fork" button at the top right of the repository page to create your own copy of the project.
+
+2. **Clone Your Fork**: Clone your forked repository to your local machine using:
+   ```sh
+   git clone https://github.com/your-username/image-optimize-cli.git
+   ```
+
+3. **Create a New Branch**: Create a new branch for your work. It's good practice to name your branch descriptively based on the changes you're making.
+   ```sh
+   git checkout -b my-feature-branch
+   ```
+
+4. **Make Changes**: Implement your changes in the code. If you're adding a new feature or fixing a bug, make sure to write clear and concise commit messages.
+
+5. **Run Tests**: Ensure that all tests pass before submitting your changes. If you’re adding new features, consider writing tests for them as well.
+   ```sh
+   npm test
+   ```
+
+6. **Commit Your Changes**: Commit your changes with a descriptive message.
+   ```sh
+   git add .
+   git commit -m "Describe your changes here"
+   ```
+
+7. **Push Your Branch**: Push your changes to your forked repository.
+   ```sh
+   git push origin my-feature-branch
+   ```
+
+8. **Open a Pull Request**: Go to the original repository and open a pull request from your forked repository and branch. Provide a clear description of your changes and why they are needed.
+
+## Coding Guidelines
+
+- **Follow the Code Style**: Ensure your code adheres to the existing code style of the project. This includes formatting, naming conventions, and coding practices.
+
+- **Write Tests**: If you're adding new features or fixing bugs, include tests to cover your changes. Ensure that all existing tests pass.
+
+- **Documentation**: Update the documentation if your changes affect how the project is used or configured. This includes README, code comments, and inline documentation.
+
+## Reporting Issues
+
+If you find a bug or have a feature request, please open an issue on the [issue tracker](https://github.com/muhammad-fiaz/image-optimize-cli/issues). Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
+
+## Contact
+
+For any questions or additional help, feel free to reach out to the maintainers via the [issue tracker](https://github.com/muhammad-fiaz/image-optimize-cli/issues) or join [discord](https://discord.com/invite/pMw7nfBzXz) directly.
+
+---
+
+Thank you for contributing to `image-optimize-cli`!
+