Skip to content

Enhance Documentation for Custom Configuration OptionsΒ #14

@grasmarcussanti129

Description

@grasmarcussanti129

Suggestion

The current README provides a good overview of the action's features and usage. However, there seems to be a lack of detailed information regarding the customization options for PHPCS standards, extensions, and ignoring specific rules.

Proposed Enhancements:

  1. Detailed Examples: Include specific examples of how to set the extensions, ignore, and standard parameters in the YAML configuration. For instance:
    inputs:
      extensions: 'php,yml'
      ignore: 'path/to/ignore/**/*'
      standard: 'PSR12'
  2. Description of Common Standards: Provide a brief description of common PHPCS standards that users might want to use, along with links to the relevant documentation.
  3. Error Messages: Explain common error messages that users might encounter during checks and potential solutions or links to resolving them.

These additions could significantly improve user experience by helping users understand how to customize the action for their specific projects effectively.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions