You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,10 @@ locally they will need to be installed. All of them (except Rector) are availabl
41
41
*[PHP CS Fixer](https://cs.symfony.com/)
42
42
*[Rector](https://github.com/rectorphp/rector/)
43
43
44
-
## Source Files
44
+
## Template Files
45
45
46
-
The provided source files should be considered guidelines or templates for your own use, as
47
-
they may need changing to fit your environment. These are based on the following assumptions:
46
+
The provided source files (in **Template/**) should be considered guidelines for your own use,
47
+
as they may need changing to fit your environment. These are based on the following assumptions:
48
48
49
49
1. Your default repository branch is set to `develop`
50
50
2. You use Composer to manage all necessary dependencies
@@ -56,7 +56,7 @@ they may need changing to fit your environment. These are based on the following
56
56
57
57
This kit includes a number of workflow templates for integrating [GitHub Actions](https://docs.github.com/en/actions)
58
58
into your library or project development process. To add these to your repo simply copy the
59
-
workflows into a **.github/workflows/** directory.
59
+
workflows into a **Template/.github/workflows/** directory.
60
60
61
61
> Hint: the [source files](src/.github) also include a configuration for Dependabot which will help keep your dependencies and workflows updated.
62
62
@@ -136,10 +136,16 @@ so be sure to read the documentation and figure out the best fit for you. This w
136
136
a "dry run" to check for any changes that Rector would have made and fail if there are matches.
137
137
138
138
> Note: Rector updates rules all the time so you may want to lock your repo to the latest known working version of Rector to prevent unexpected failures
139
-
> E.g. in **.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4`
139
+
> E.g. in **Template/.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4`
140
140
141
141
#### Unused
142
142
143
143
Composer Unused does one thing: checks that your code actually uses the dependencies you
144
144
have included via Composer. It can be easy to forget to update your **composer.json** when
145
145
your code drops a dependency, so this workflow will help track those down.
146
+
147
+
## Example Files
148
+
149
+
Besides the template files, this repo includes some examples for integrating CodeIgniter
150
+
with other third-party resources. These files (in **Examples/**) may change over time and
151
+
should not be relied on for anything more than a reference for your own code.
0 commit comments