generated from hydephp/hyde
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #133 from hydephp/release/v0.7.51
HydeCLI v0.7.51
- Loading branch information
Showing
4 changed files
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing | ||
|
||
Contributions are **welcome** and will be fully **credited**. | ||
|
||
Please read and understand the contribution guide before creating an issue or pull request. This document is a living standard that may be updated when needed. | ||
|
||
## Resources and guidance | ||
|
||
This repository contains the code for the standalone HydePHP executable project. If you want to contribute to a feature within HydePHP itself, | ||
please visit the main HydePHP development repository https://github.com/hydephp/develop. | ||
|
||
If you want to contribute to something specially related to the HydePHP CLI, you're in the right place! | ||
|
||
## Development setup | ||
|
||
1. Fork the repository on GitHub | ||
2. Clone your fork to your local machine | ||
3. Install dependencies with `composer install` | ||
|
||
You can run a live version of the executable by running `php hyde <command>` in the project root to test your changes. | ||
|
||
## Testing | ||
|
||
Please add tests for any new features or bug fixes. Tests are run using PestPHP. | ||
|
||
```bash | ||
vendor/bin/pest | ||
``` | ||
|
||
## Releases | ||
|
||
Releases are handled by the maintainers of the project according to the following workflow: | ||
1. The `create-release.yml` GitHub Actions workflow is triggered by workflow dispatch, where the maintainer specifies the SemVer level. | ||
2. The workflow updates the application version constant and compiles the application. It then creates a new branch and creates a pull request. | ||
3. The maintainer reviews the pull request and merges it into the protected stable branch when ready. | ||
4. The `publish-release.yml` GitHub Actions workflow is triggered by the merge, which creates a new release on GitHub with the compiled application attached. It also syncs the changes to the main branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.