Skip to content

Commit 830baa1

Browse files
committed
Update "Contributing" Notes and One Github Action
Replace one deprecated action, and update "How to release".
1 parent eec07c2 commit 830baa1

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ jobs:
210210
runs-on: ubuntu-latest
211211
steps:
212212
- name: Checkout
213-
uses: actions/checkout@v3
213+
uses: actions/checkout@v4
214214
with:
215215
fetch-depth: 0
216216

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ If you would like to contribute, here are some notes and guidelines:
44

55
- All new development should be on feature/fix branches, which are then merged to the `master` branch once stable and approved; so the `master` branch is always the most up-to-date, working code
66
- If you are going to submit a pull request, please fork from `master`, and submit your pull request back as a fix/feature branch referencing the GitHub issue number
7+
- Install (development) dependencies by running `composer install` inside your PhpSpreadsheet clone.
78
- The code must work with all PHP versions that we support.
89
- You can call `composer versions` to test version compatibility.
910
- Code style should be maintained.
@@ -39,7 +40,10 @@ This makes it easier to see exactly what is being tested when reviewing the PR.
3940
2. Tag subject must be the version number, eg: `1.2.3`
4041
3. Tag body must be a copy-paste of the changelog entries.
4142
3. Push the tag with `git push --tags`, GitHub Actions will create a GitHub release automatically, and the release details will automatically be sent to packagist.
42-
4. Github seems to remove markdown headings in the Release Notes, so you should edit to restore these.
43+
4. By default, Github remove markdown headings in the Release Notes. You can either edit to restore these, or, probably preferably, change the default comment character on your system - `git config core.commentChar ';'`.
4344

44-
> **Note:** Tagged releases are made from the `master` branch. Only in an emergency should a tagged release be made from the `release` branch. (i.e. cherry-picked hot-fixes.)
45+
> **Note:** Tagged releases are made from the `master` branch. Only in an emergency should a tagged release be made from the `release` branch. (i.e. cherry-picked hot-fixes.) However, there are 3 branches which have been updated to apply security patches, and those may be tagged if future security updates are needed.
46+
- release1291
47+
- release210
48+
- release222
4549

0 commit comments

Comments
 (0)