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: .github/CONTRIBUTING.md
+36-15Lines changed: 36 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Before you begin, you will need to set up your local development environment. He
20
20
21
21
-[Pre-commit](https://pre-commit.com) — Automates the running of git pre-commit hooks.
22
22
- Installation: `brew install pre-commit` and `make hooks`
23
-
-[Cz-git](https://cz-git.qbb.sh) —Commitizen adapter, that assists in formatting git commits.
23
+
-[Cz-git](https://cz-git.qbb.sh) —Commitizen adapter, that assists in formatting git commits.
24
24
- Installation: `brew install czg`
25
25
26
26
<br>
@@ -58,6 +58,10 @@ Refer to the output of `make help` for a comprehensive list of available command
58
58
-**Fork the Repository**: Start by forking the repository to your GitHub account.
59
59
-**Create a Branch**: In your fork, create a new branch for your work. Name it appropriately based on the feature, fix, or update you're working on.
60
60
-**Make Your Changes**: Implement your changes, commit them, and push the branch to your fork.
61
+
-**Run Tests**: Ensure all tests pass and the code adheres to the coding standards.
62
+
-**Update Documentation**: If you've made changes that affect the project's documentation, ensure it is updated.
63
+
-**Run Linters**: Ensure your code passes all linting checks using `make lint`.
64
+
-**Commit Your Changes**: Use the [Conventional Commits](#-commit-message-guidelines) standard for your commit messages. You can use `make commit` to assist in creating commit messages.
61
65
-**Open a Pull Request**: Submit a pull request to the `master` branch of the original repository. Ensure your PR is focused, addressing a single feature, fix, or improvement.
62
66
63
67
<br>
@@ -120,21 +124,21 @@ $ git commit -am 'fix: something has been fixed'
|`refactor`| Code changes that neither fixes a bug nor adds a feature |
136
+
|`ci`| Changes to our CI configuration files and scripts |
137
+
|`test`| Adding missing tests or correcting existing tests |
138
+
|`revert`| Reverts a previous commit |
135
139
|`build`| Changes that affect the build system or external dependencies |
136
-
|`chore`| Other changes that don't modify src or test files |
137
-
|`security`| A code change that fixes a security issue |
140
+
|`chore`| Other changes that don't modify src or test files |
141
+
|`security`| A code change that fixes a security issue |
138
142
139
143
<br>
140
144
@@ -164,6 +168,23 @@ $ make lint-yaml
164
168
165
169
by default, [`cytopia/yamllint`](https://github.com/cytopia/docker-yamllint) Docker image will be used to run linter.
166
170
171
+
<br>
172
+
173
+
### → Action Lint
174
+
175
+
We use [`actionlint`](https://github.com/rhysd/actionlint) to enforce coding standards in GitHub Actions workflows.
176
+
177
+
178
+
To lint GitHub Actions run:
179
+
180
+
```bash
181
+
$ make lint-actions
182
+
```
183
+
184
+
by default, [`rhysd/actionlint`](https://hub.docker.com/r/rhysd/actionlint/tags) Docker image will be used to run linter.
185
+
186
+
<br>
187
+
167
188
### → PHP CS Fixer
168
189
169
190
We use [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) together with [`wayofdev/php-cs-fixer-config`](https://github.com/wayofdev/php-cs-fixer-config) to enforce coding standards in PHP files.
0 commit comments