Skip to content

Commit

Permalink
Merge branch 'main' into gitauto/issue-#235-e9717850-6cb0-4c71-977a-0…
Browse files Browse the repository at this point in the history
…252215df6ea
  • Loading branch information
guibranco authored Jan 6, 2025
2 parents ab48299 + 7c917a3 commit 1c99e64
Show file tree
Hide file tree
Showing 26 changed files with 756 additions and 161 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ jobs:
fetch-depth: 0

- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v2
uses: gittools/actions/gitversion/setup@v3
with:
versionSpec: '5.x'

- name: Determine Version
id: gitversion
uses: gittools/actions/gitversion/execute@v2
uses: gittools/actions/gitversion/execute@v3
with:
useConfigFile: true

Expand All @@ -45,7 +45,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codacy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/code-climate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand All @@ -48,7 +48,7 @@ jobs:
sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.xml
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4.6.0
uses: codecov/codecov-action@v5.1.2
with:
token: ${{ secrets.CODECOV_TOKEN }}
slug: guibranco/Pancake
2 changes: 1 addition & 1 deletion .github/workflows/deep-source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/infisical-secrets-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
fetch-depth: 0

- name: Infisical secrets check
uses: guibranco/[email protected].15
uses: guibranco/[email protected].24
3 changes: 2 additions & 1 deletion .github/workflows/sonar-cloud.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 0

- name: Cache Composer dependencies
uses: actions/cache@v4
Expand All @@ -30,7 +31,7 @@ jobs:
run: docker compose up -d && sleep 10

- name: PHPUnit Tests
uses: php-actions/phpunit@v3
uses: php-actions/phpunit@v4
with:
version: 11
php_version: 8.3
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
"cSpell.words": [
"Codacy",
"Codecov",
"CURLOPT",
"httponly",
"Packagist"
"Packagist"
]
}
90 changes: 80 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,84 @@
# Contributing
# Contributing to Pancake 🥞

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Add files changed: `git add .`
4. Commit your changes: `git commit -m "Add some feature"`
5. Push to the branch: `git push origin my-new-feature`
6. Submit a pull request
First off, thank you for considering contributing to Pancake! Your input and contributions help us make this library better for everyone. This document outlines the process and guidelines for contributing to the project.

- The pull request and commit should have a helpful title.
## Getting Started 🚀

**After your pull request is merged**
1. **Fork the repository**: Visit [Pancake on GitHub](https://github.com/guibranco/pancake) and click the `Fork` button.
2. **Clone your fork**: Use the following command to clone the repository locally:
```bash
git clone https://github.com/<your-username>/pancake.git
```
3. **Install dependencies**: Run the following command to install the necessary dependencies via Composer:
```bash
composer install
```
4. **Create a branch**: Create a new branch for your feature or bug fix:
```bash
git checkout -b <feature-or-bugfix-name>
```

## Development Guidelines 🛠️

### Code Style ✍️

- Follow the [PHP-FIG PSRs](https://www.php-fig.org/psr/) (e.g., PSR-1, PSR-12).
- Ensure your code is clean and readable.
- Use meaningful variable and method names.

### Compatibility 💻

- Pancake targets **PHP 8+** but aims to maintain compatibility with lower PHP versions when feasible. Test your changes across multiple PHP versions if possible.

### Testing 🧪

- We use [PHPUnit](https://phpunit.de/) for unit testing. Add tests for any new features or bug fixes.
- Ensure that the library maintains at least **80% code coverage**.
- Run tests locally using:
```bash
./vendor/bin/phpunit
```

### Documentation 📖

- Update documentation in the `docs/` directory and any relevant markdown files if your changes affect functionality.
- Documentation is published via GitHub Pages, so ensure all updates are clear and concise.

### Composer Support 🎵

- The library is distributed via Composer. Ensure that `composer.json` reflects accurate metadata and dependencies for your changes.

## Submitting Your Contribution 📨

1. **Commit your changes**: Follow good commit message practices. Example:
```
[FEATURE] Add new Pancake flipping method
```
2. **Push your branch**: Push your branch to your forked repository:
```bash
git push origin <feature-or-bugfix-name>
```
3. **Create a Pull Request (PR)**: Go to the original [Pancake repository](https://github.com/guibranco/pancake) and open a pull request.

### Pull Request Checklist ✅

- [x] Code follows the PSRs and project standards.
- [x] All tests pass with PHPUnit.
- [x] Code coverage is at least 80%.
- [x] Documentation has been updated (if required).
- [x] PR description clearly explains the purpose and changes.

## Reporting Issues 🐞

If you find a bug or have a feature request, please open an issue in the [GitHub Issues](https://github.com/guibranco/pancake/issues) section. Include as much detail as possible:

- Steps to reproduce (for bugs)
- Use cases and rationale (for features)
- Environment details (e.g., PHP version, OS)

## Community and Support 🤝

If you have any questions or need help contributing, feel free to reach out by opening a discussion in the repository. We're happy to assist!

Thank you for contributing to Pancake! 🥞 Together, we can build a better library.

After your pull request is merged, you can safely delete your branch.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,17 +179,17 @@ Refer to [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this p
</a>
</td>
<td align="center">
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<br />
<sub><b>deepsource-autofix[bot]</b></sub>
<sub><b>gitauto-ai[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<br />
<sub><b>gitauto-ai[bot]</b></sub>
<sub><b>deepsource-autofix[bot]</b></sub>
</a>
</td>
<td align="center">
Expand Down
19 changes: 0 additions & 19 deletions SECURITY.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Changelog

## Version 1.0 [2024-12-21]
- [#287](https://github.com/guibranco/pancake/issues/287) - Add support for `curl_multi_init` in `Request` class by [@guibranco](https://github.com/guibranco).

## Version 0.14 [2024-10-26]

- [#83](https://github.com/guibranco/pancake/issues/83) - Add Database class by [@guibranco](https://github.com/guibranco).
Expand Down
12 changes: 6 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,17 @@ Refer to [CONTRIBUTING.md](https://github.com/guibranco/Pancake/blob/main/CONTRI
</a>
</td>
<td align="center">
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<br />
<sub><b>deepsource-autofix[bot]</b></sub>
<sub><b>gitauto-ai[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<a href="https://github.com/deepsource-autofix[bot]">
<img src="https://avatars.githubusercontent.com/in/57168?v=4" width="100;" alt="deepsource-autofix[bot]"/>
<br />
<sub><b>gitauto-ai[bot]</b></sub>
<sub><b>deepsource-autofix[bot]</b></sub>
</a>
</td>
<td align="center">
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Pancake project is a set of libraries for basic PHP projects with API and/or

## Github Releases

[![GitHub last release](https://img.shields.io/github/release-date/guibranco/Pancake.svg?style=flat)](https://github.com/guibranco/Pancake) [![Github All Releases](https://img.shields.io/github/downloads/guibranco/Pancake/total.svg?style=flat)](https://github.com/guibranco/Pancake)
[![GitHub last release](https://img.shields.io/github/release-date/guibranco/Pancake.svg?style=flat)](https://github.com/guibranco/Pancake) [![Github All Releases](https://img.shields.io/github/downloads/guibranco/Pancake/total.svg?style=flat)](https://github.com/guibranco/pancake/releases/latest)

Download the latest zip file from the [Release](https://github.com/GuiBranco/Pancake/releases) page.
Download the latest zip file from the [Release](https://github.com/guibranco/pancake/releases/latest) page.

## Packagist package repository

Expand Down
Loading

0 comments on commit 1c99e64

Please sign in to comment.