Skip to content

Commit aef4138

Browse files
ejntaylorclaude
andcommitted
Add MIT license, contributing guidelines, update for public repo
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6a52955 commit aef4138

3 files changed

Lines changed: 39 additions & 3 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Patchstack
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ PHP's `version_compare('3.5', '3.41')` returns `-1` (meaning 3.5 < 3.41), becaus
1212
composer require patchstack/version-compare
1313
```
1414

15-
For private repo access, add the VCS repository to your `composer.json`:
15+
Since this package is not on Packagist, add the VCS repository to your `composer.json`:
1616

1717
```json
1818
{
1919
"repositories": [
2020
{
2121
"type": "vcs",
22-
"url": "git@github.com:patchstack/version-compare.git"
22+
"url": "https://github.com/patchstack/version-compare.git"
2323
}
2424
]
2525
}
@@ -125,6 +125,21 @@ $checker->execute('9.x-3.4', '<= 8.x-3.5'); // false (different major)
125125
composer test
126126
```
127127

128+
## Contributing
129+
130+
This package is maintained by the Patchstack engineering team. Changes should be made via pull request with tests.
131+
132+
When adding new version format support:
133+
1. Add test cases covering the new format in the relevant test file
134+
2. Ensure all existing tests still pass
135+
3. Update this README's "Supported Version Formats" table
136+
137+
Version bumps follow semver. Breaking changes to the public API require a major version bump since multiple codebases depend on `^1.0`.
138+
139+
## License
140+
141+
MIT - see [LICENSE](LICENSE)
142+
128143
## Requirements
129144

130145
- PHP 8.1+

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "patchstack/version-compare",
33
"description": "Framework-agnostic version comparison logic for vulnerability checking",
44
"type": "library",
5-
"license": "proprietary",
5+
"license": "MIT",
66
"require": {
77
"php": "^8.1"
88
},

0 commit comments

Comments
 (0)