contrib/php-uuid
1
0
Fork 0
mirror of https://github.com/ramsey/uuid.git synced 2026-06-14 15:56:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: update package files

Browse Source
This commit is contained in:
Ben Ramsey
2021-08-06 14:05:57 -05:00
parent 90a87a7543
commit c005f69d6e
67 changed files with 890 additions and 615 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CODEOWNERS
+1
View File
@@ -0,0 +1 @@
* @ramsey
.github/CODE_OF_CONDUCT.md
-73
View File
@@ -1,73 +0,0 @@
# Contributor Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project maintainer(s) at <ben@benramsey.com>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at <http://contributor-covenant.org/version/1/4>.
[homepage]: http://contributor-covenant.org
.github/CONTRIBUTING.md
-101
View File
@@ -1,101 +0,0 @@
# Contributing
Contributions are welcome. I accept pull requests on [GitHub][].
You can triage issues which may include reproducing bug reports or asking for
vital information, such as version numbers or reproduction instructions. If you
would like to start triaging issues, one easy way to get started is to
[subscribe to ramsey/uuid on CodeTriage](https://codetriage.com/ramsey/uuid).
This project adheres to a [Contributor Code of Conduct][]. By participating in
this project and its community, you are expected to uphold this code.
## Communication Channels
You can find help and discussion in the following places:
* GitHub Issues: <https://github.com/ramsey/uuid/issues>
## Reporting Bugs
Bugs are tracked in the project's [issue tracker][issues].
When submitting a bug report, please include enough information to reproduce the
bug. A good bug report includes the following sections:
* Expected outcome
* Actual outcome
* Steps to reproduce, including sample code
* Any other information that will help debug and reproduce the issue, including
stack traces, system/environment information, and screenshots
**Please do not include passwords or any personally identifiable information in
your bug report and sample code.**
## Fixing Bugs
I welcome pull requests to fix bugs!
If you see a bug report that you'd like to fix, please feel free to do so.
Following the directions and guidelines described in the "Adding New Features"
section below, you may create bugfix branches and send pull requests.
## Adding New Features
If you have an idea for a new feature, it's a good idea to check out the
[issues][] or active [pull requests][] first to see if the feature is already
being worked on. If not, feel free to submit an issue first, asking whether the
feature is beneficial to the project. This will save you from doing a lot of
development work only to have your feature rejected. I don't enjoy rejecting
your hard work, but some features just don't fit with the goals of the project.
When you do begin working on your feature, here are some guidelines to consider:
* Your pull request description should clearly detail the changes you have made.
I will use this description to update the CHANGELOG. If there is no
description or it does not adequately describe your feature, I will ask you
to update the description.
* ramsey/uuid follows the **[PSR-2 coding standard][psr-2]**. Please
ensure your code does, too.
* Please **write tests** for any new features you add.
* Please **ensure that tests pass** before submitting your pull request.
ramsey/uuid has Travis CI automatically running tests for pull requests.
However, running the tests locally will help save time.
* **Use topic/feature branches.** Please do not ask to pull from your master
branch.
* For more information, see "[Understanding the GitHub flow][gh-flow]."
* **Submit one feature per pull request.** If you have multiple features you
wish to submit, please break them up into separate pull requests.
* **Write good commit messages.** Make sure each individual commit in your pull
request is meaningful. If you had to make multiple intermediate commits while
developing, please squash them before submitting.
* For more information, see "[How to Write a Git Commit Message][git-commit]."
## Running Tests
The following must pass before I will accept a pull request. If this does not
pass, it will result in a complete build failure. Before you can run this, be
sure to `composer install` ([download Composer][]).
To run all the tests and coding standards checks, execute the following from the
command line, while in the project root directory (the same place as the
`composer.json` file):
```
composer run-script test
```
[github]: https://github.com/ramsey/uuid
[contributor code of conduct]: https://github.com/ramsey/uuid/blob/master/.github/CODE_OF_CONDUCT.md
[issues]: https://github.com/ramsey/uuid/issues
[pull requests]: https://github.com/ramsey/uuid/pulls
[psr-2]: https://www.php-fig.org/psr/psr-2/
[gh-flow]: https://guides.github.com/introduction/flow/
[git-commit]: https://chris.beams.io/posts/git-commit/
[download composer]: https://getcomposer.org/
.github/ISSUE_TEMPLATE/Bug_Report.md
+35
View File
@@ -0,0 +1,35 @@
---
name: Bug Report
about: Create a bug report to help us improve
labels: bug
assignees:
---
<!--- Provide a general summary of the issue you're having in the title above. -->
## Description
<!-- Provide a short and clear description of the bug. -->
## Steps to reproduce
<!--
Provide steps to reproduce the behavior you are experiencing. Please try to keep
this as short as possible. If able, create a reproducible script outside of any
framework you are using. This will help us to quickly debug the issue.
-->
1. Step one...
2. Step two...
3. Step three...
## Expected behavior
<!-- Provide a short and clear description of what you expect to happen. -->
## Screenshots or output
<!-- If applicable, add screenshots or program output to help explain your problem. -->
## Environment details
<!-- Provide details about the system where you're using this package. -->
- version of this package: *e.g. 1.0.0, 1.0.1, 1.1.0*
- PHP version: *e.g. 7.3.16, 7.4.4*
- OS: *e.g. Windows 10, Linux (Ubuntu 18.04.1), macOS Catalina (10.15.3)*
## Additional context
<!-- Provide any additional context that may help us debug the problem. -->
.github/ISSUE_TEMPLATE/Feature_Request.md
+31
View File
@@ -0,0 +1,31 @@
---
name: Feature Request
about: Suggest a feature for this project
labels: enhancement
assignees:
---
<!--- Provide a general summary of your feature request in the title above. -->
<!-- Give your feature a short title here. -->
## My feature title
<!-- Provide a short and clear description of the feature. -->
## Background/problem
<!--
Provide background details to show why this feature is necessary. Is your
feature request related to a problem? If so, please describe the problem.
Provide as much detail as possible.
-->
## Proposal/solution
<!--
Provide a short and clear description of the solution you'd like. Include code
examples, if possible. Feel free to use pseudo-code to show how you think the
feature should work.
-->
## Alternatives
<!-- Describe any alternative solutions or features you've considered. -->
## Additional context
<!-- Please provide any other context or code examples that may help. -->
.github/ISSUE_TEMPLATE/Question.md
+19
View File
@@ -0,0 +1,19 @@
---
name: Question
about: Ask a question about how to use this library
labels: question
assignees:
---
<!--- Provide a general summary of your question in the title above. -->
<!-- Write your question here. -->
## How do I... ?
<!-- Provide any additional context that may help us answer your question. -->
## Example code
<!--
If your question is about code that you've written, provide a short and clear
example of what you're trying to accomplish. Try to keep this as short as
possible. If able, please provide an example outside of any framework you are
using. This will help us to quickly respond to your question.
-->
.github/ISSUE_TEMPLATE/bug_report.md
-55
View File
@@ -1,55 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug
assignees:
---
## Describe the bug
A clear and concise description of what the bug is.
## To Reproduce...
Steps to reproduce the behavior (include code examples, if applicable):
1. Create script `foo.php` and add the following:
``` php
<?php
require_once 'vendor/autoload.php';
$foo = new Foo\Bar();
// Code that, when run, shows the behavior...
```
2. Execute the script from a terminal:
``` bash
$ php foo.php
```
3. See output similar to the following:
```
Error message or wrong output...
```
## Expected behavior
A clear and concise description of what you expected to happen.
## Screenshots or output
If applicable, add screenshots or program output to help explain your problem.
## Environment details
- OS: [e.g. Windows 10, Linux (Ubuntu 18.04.1), macOS Mojave (10.14.2)]
- PHP version: [e.g. 7.1.25, 7.2.13]
- ramsey/uuid version: [e.g. 1.0.0, 1.0.1, 1.1.0]
## Additional context
Add any other context about the problem here.
.github/ISSUE_TEMPLATE/config.yml
+1
View File
@@ -0,0 +1 @@
blank_issues_enabled: false
.github/ISSUE_TEMPLATE/feature_request.md
-22
View File
@@ -1,22 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
labels: enhancement
assignees:
---
## Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Describe the solution you'd like
A clear and concise description of what you want to happen. Include code examples, if applicable.
## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
## Additional context
Add any other context or code examples about the feature request here.
.github/dependabot.yml
+7
View File
@@ -0,0 +1,7 @@
version: 2
updates:
- package-ecosystem: "composer"
directory: "/"
schedule:
interval: "monthly"
versioning-strategy: "increase-if-necessary"
.github/PULL_REQUEST_TEMPLATE.md → .github/pull_request_template.md
+2 -5
View File
@@ -18,13 +18,10 @@
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Checklist:
## PR checklist
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **[CONTRIBUTING.md](https://github.com/ramsey/uuid/blob/master/.github/CONTRIBUTING.md)** document.
- [ ] I have read the **CONTRIBUTING.md** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] I have run `composer run-script test` locally, and there were no failures or errors.
.github/workflows/continuous-integration.yml
+90 -39
View File
@@ -1,54 +1,64 @@
# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
# GitHub Actions Documentation: https://docs.github.com/en/actions
name: "CI"
name: "build"
on:
pull_request:
push:
branches:
- "master"
on: ["pull_request", "push"]
env:
COMPOSER_ROOT_VERSION: "1.99.99"
jobs:
coding-standards:
name: "Coding Standards"
name: "Coding standards"
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v2"
- uses: "shivammathur/setup-php@v2"
- name: "Checkout repository"
uses: "actions/checkout@v2"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "7.4"
php-version: "latest"
extensions: bcmath, ctype, gmp
coverage: "none"
ini-values: "memory_limit=-1"
- uses: "ramsey/composer-install@v1"
- name: "Run the linter"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v1"
- name: "Check syntax (php-parallel-lint)"
run: "composer lint -- --colors"
- name: "Check coding standards"
- name: "Check coding standards (PHP_CodeSniffer)"
run: "./vendor/bin/phpcs --colors"
static-analysis:
name: "Static Analysis"
name: "Static analysis"
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v2"
- uses: "shivammathur/setup-php@v2"
- name: "Checkout repository"
uses: "actions/checkout@v2"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "7.4"
php-version: "latest"
extensions: bcmath, ctype, gmp
coverage: "none"
ini-values: "memory_limit=-1"
- uses: "ramsey/composer-install@v1"
- name: "Run PHPStan"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v1"
- name: "Statically analyze code (PHPStan)"
run: "composer phpstan -- --ansi"
- name: "Run Psalm"
- name: "Statically analyze code (Psalm)"
run: "composer psalm -- --shepherd"
benchmark:
name: "Benchmark"
runs-on: "ubuntu-latest"
continue-on-error: ${{ matrix.experimental }}
strategy:
fail-fast: false
matrix:
@@ -56,30 +66,65 @@ jobs:
- "7.2"
- "7.3"
- "7.4"
- "8.0"
experimental:
- false
include:
- php-version: "8.0"
- php-version: "8.1"
experimental: true
composer-options: "--ignore-platform-reqs"
composer-options: "--ignore-platform-req=php"
steps:
- uses: "actions/checkout@v2"
- uses: "shivammathur/setup-php@v2"
- name: "Checkout repository"
uses: "actions/checkout@v2"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "${{ matrix.php-version }}"
extensions: bcmath, ctype, gmp
coverage: "none"
ini-values: "memory_limit=-1"
- uses: "ramsey/composer-install@v1"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v1"
with:
composer-options: "${{ matrix.composer-options }}"
- name: "Run PHPBench"
run: "composer phpbench -- --ansi"
code-coverage:
name: "Code coverage"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout repository"
uses: "actions/checkout@v2"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "latest"
extensions: bcmath, ctype, gmp
coverage: "pcov"
ini-values: "memory_limit=-1"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v1"
with:
dependency-versions: "${{ matrix.dependencies }}"
- name: "Run unit tests (PHPUnit)"
run: "./vendor/bin/phpunit --verbose --colors=always --coverage-text --coverage-clover build/logs/clover.xml"
- name: "Publish coverage report to Codecov"
uses: "codecov/codecov-action@v1"
unit-tests:
name: "Unit Tests"
runs-on: "ubuntu-latest"
continue-on-error: ${{ matrix.experimental }}
strategy:
fail-fast: false
matrix:
@@ -87,24 +132,30 @@ jobs:
- "7.2"
- "7.3"
- "7.4"
- "8.0"
experimental:
- false
include:
- php-version: "8.0"
- php-version: "8.1"
experimental: true
composer-options: "--ignore-platform-reqs"
composer-options: "--ignore-platform-req=php"
steps:
- uses: "actions/checkout@v2"
- uses: "shivammathur/setup-php@v2"
- name: "Checkout repository"
uses: "actions/checkout@v2"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "${{ matrix.php-version }}"
extensions: bcmath, ctype, gmp
coverage: "pcov"
coverage: "none"
ini-values: "memory_limit=-1"
- uses: "ramsey/composer-install@v1"
- name: "Install dependencies (Composer)"
uses: "ramsey/composer-install@v1"
with:
composer-options: "${{ matrix.composer-options }}"
- name: "Run unit tests"
run: "./vendor/bin/phpunit --verbose --colors=always --coverage-clover build/logs/clover.xml --coverage-text"
- name: "Publish coverage report to Codecov"
uses: "codecov/codecov-action@v1"
- name: "Run unit tests (PHPUnit)"
run: "./vendor/bin/phpunit --verbose --colors=always --no-coverage"