From a5d4afd91a5b41706595cb80c8e628e56aea74aa Mon Sep 17 00:00:00 2001 From: Morteza Poussaneh Date: Sun, 16 Mar 2025 21:41:28 +0100 Subject: [PATCH] add comunity files --- .github/CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 31 +++++++++ .github/SECURITY.md | 26 ++++++++ README.md | 54 +++------------- 4 files changed, 194 insertions(+), 45 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/SECURITY.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..43f1961 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +morteza@protonmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..aa3cddd --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +## Setting Up the Development Environment + +To contribute to the Console Package, follow these steps: + +1. Clone the repository: + + ```bash + git clone https://github.com/php-repos/console.git + cd console + ``` + +2. Install dependencies: + ```bash + phpkg install + ``` +3. Build the project: + + ```bash + phpkg build + ``` + +4. Contribute your changes. + +5. Test your changes: + + ```bash + cd builds/development + phpkg run https://github.com/php-repos/test-runner.git + ``` \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..78b6c73 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,26 @@ +# Security Policy + +## Supported Versions + +The following versions of the Console Package are currently supported with security updates: + +| Version | Supported | +|---------|--------------------| +| 3.0.0 | :white_check_mark: | + +## Reporting a Vulnerability + +If you discover a security vulnerability in the Console Package, please report it to us as soon as possible. We take security seriously and aim to address reported issues promptly. + +To report a vulnerability: +- **Email us**: Send details to [morteza@protonmail.com](mailto:morteza@protonmail.com). +- **What to include**: Provide a detailed description of the vulnerability, steps to reproduce (if possible), and any potential impact. +- **Response time**: We will acknowledge your email within 48 hours and work with you to assess and resolve the issue. + +Please refrain from disclosing the vulnerability publicly (e.g., in GitHub issues or forums) until we’ve had a chance to address it. We’ll coordinate with you on a timeline for public disclosure if necessary. + +## Security Updates + +Once a vulnerability is confirmed and fixed, we’ll release a patch version (e.g., 1.2.3 to 1.2.4) and update this policy with details of the fix. + +Thank you for helping keep the Console Package secure! \ No newline at end of file diff --git a/README.md b/README.md index 1155438..ac8bf6c 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,7 @@ The Console Package simplifies creating and running CLI commands for PHP applica --- -## Usage - -### Installation +## Installation To use the Console Package, install it as a dependency with `phpkg`: @@ -16,7 +14,7 @@ To use the Console Package, install it as a dependency with `phpkg`: phpkg add https://github.com/php-repos/console.git ``` -### Running Commands +## Running Commands After installation, build your project with `phpkg build` to access the Console Package’s CLI functionality. You can run commands using either of these methods from the `builds/development` directory: @@ -34,7 +32,7 @@ After installation, build your project with `phpkg build` to access the Console Both methods provide identical access to the Console Package’s CLI commands—choose the one that fits your workflow. -### Creating Commands +## Creating Commands Create commands by adding files under the `Source/Commands` directory. Use PascalCase filenames matching the command name (e.g., `MakeUserCommand.php` for `make-user`). @@ -42,7 +40,7 @@ Create commands by adding files under the `Source/Commands` directory. Use Pasca Subcommands are supported via directory structure. For example, to create a `users:create` subcommand, add a file at `Source/Commands/Users/CreateCommand.php`. The Console Package maps directory paths to command names using `/` as a separator. -#### Defining Command Options +### Defining Command Options Use attributes to define options in your command file. Here’s an example: @@ -65,7 +63,7 @@ return function ( Long options (e.g., `--email`) and short options (e.g., `-p`) support PHP types (`string`, `bool`, etc.). Optional parameters can use nullable types (e.g., `?bool`) or default values. -#### Defining Command Arguments +### Defining Command Arguments Add the Argument attribute to accept command-line arguments: @@ -90,7 +88,7 @@ return function ( Arguments are positional and mandatory unless marked nullable (e.g., ?string) or given a default value. -#### Adding Command Help +### Adding Command Help Document your command with a docblock for general help: @@ -120,7 +118,7 @@ View help with: ./console make-user --help # Shows make-user details ``` -#### Documenting Parameters +### Documenting Parameters Add Description attributes for detailed argument and option help: @@ -165,7 +163,7 @@ Options: -p The password for user login -f, --force Force user creation ``` -### Examples +## Examples - File Operation Command @@ -232,7 +230,7 @@ Options: ./console users/create --help ``` -### Advanced Customization +## Advanced Customization To customize command loading, create a file like `cli` in your project root. Here’s an example: @@ -253,37 +251,3 @@ require Resolver\realpath(__DIR__ . '/Packages/php-repos/console/console'); ``` This changes the command directory to `Src/MyCommands` and uses `.php` as the suffix. Add `cli` to your `phpkg.config.json` under `entry-points` for it to work. - ---- - -## Contributing - -### Setting Up the Development Environment - -To contribute to the Console Package, follow these steps: - -1. Clone the repository: - - ```bash - git clone https://github.com/php-repos/console.git - cd console - ``` - -2. Install dependencies: - ```bash - phpkg install - ``` -3. Build the project: - - ```bash - phpkg build - ``` - -4. Contribute your changes. - -5. Test your changes: - - ```bash - cd builds/development - phpkg run https://github.com/php-repos/test-runner.git - ``` \ No newline at end of file