leonhusmann/composer-contribute

Find open issues in your dependencies and contribute to the packages you rely on.

dev-main 2024-10-11 06:20 UTC

Requires

• php: ^8.2
• composer-plugin-api: ^2.0
• ext-curl: *
• composer/composer: ^2.8
• symfony/console: ^7.1

Requires (Dev)

• doctrine/coding-standard: 13.0.x-dev
• ergebnis/composer-normalize: dev-main
• phpunit/phpunit: ^11
• shipmonk/composer-dependency-analyser: dev-master
• squizlabs/php_codesniffer: ^3.0

MIT

• Leon Husmann

README

Composer Contribute is a Composer plugin that helps you find open issues in your project dependencies, allowing you to contribute to the packages you rely on. It's particularly useful during events like Hacktoberfest.

Features

• Lists open issues from your Composer dependencies.
• Filter issues by labels (e.g., good first issue, help wanted, hacktoberfest).

Installation

Global Installation

To install this plugin globally, run:

composer global require leonhusmann/composer-contribute

This will install the plugin and make the contribute command available globally.

Usage

Once installed, you can use the contribute command to find open issues from your project dependencies:

composer contribute

This command will query the dependencies of your current Composer project and list any open issues you can contribute to.

Contributing

We welcome contributions! Here's how you can get started with local development and testing.

Local Development Setup

To contribute to this project, follow these steps to set up the plugin for local development:

1. Fork this repository and clone your fork locally:

   git clone https://github.com/leonhusmann/composer-contribute.git
   cd composer-contribute

2. Run composer install to install the required dependencies.

3. Add the local repository path to your global Composer configuration:

   composer global config repositories.local path /path/to/your/local/fork

   Replace /path/to/your/local/fork with the actual path where you cloned the project.

4. Install the plugin globally in development mode:

   composer global require leonhusmann/composer-contribute:@dev

5. Ensure your global composer.json allows development versions by setting the minimum-stability to dev:

   composer global config minimum-stability dev

6. Now, you can test the contribute command:

   composer contribute

License

This project is licensed under the MIT License. See the LICENSE file for details.