Should have a "minimum-stability" description at documentation?

Open
#1,058 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
php
Domain
documentation

Research direction

Start with the composer.json example in the issue and review the stability requirements of geocoder-php/google-maps-provider, php-http/guzzle6-adapter, and the Geocoder providers. Confirm the minimum stability needed for a normal installation, then document that guidance and the relevant provider setup for users.

Written by the indexing model from the issue text.

Description

So, In my very first install, my project has a "minimum-stability : stable" instruction into composer.json. It hurts the installation process of some (or all) dependencies, so I could not fix that changing to "dev" instead of "stable" and installing puli/composer-plugin, so I don't know what is the best approach here. Could anyone describe the necessary minimum-stability to use the Geocoder package and additional providers?

Bellow, it is my current composer.json dependencies:

{
    "name": "marcos/itcm-google-maps-interceptor-for-csv-importer",
    "type": "project",
    "require": {
        "geocoder-php/google-maps-provider": "^4.4",
        "php-http/guzzle6-adapter": "^2.0",
        "vlucas/phpdotenv": "^4.1"
    },
    "minimum-stability": "dev",
    "require-dev": {
        "symfony/var-dumper": "^5.0"
    }
}
Dominant language
PHP
Stars
4k
Forks
525
Avg merge
8m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from geocoder-php/Geocoder

All issues in geocoder-php/Geocoder

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.