Skip to content

Commit 73249a8

Browse files
authored
prepare-for-packaging: Explicitly mention linting (#602)
1 parent 7d29f3d commit 73249a8

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/packaging/prepare-for-packaging.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,19 @@ Create a local clone of the package repository you just forked. Here we are usin
101101
gh repo clone packages ~/solus-packages
102102
```
103103

104-
## Initialize git hooks
104+
## Initialize git hooks for linting
105105

106-
Initialize Git hooks for working with the repository by running:
106+
The process of checking whether package recipes have issues is sometimes referred to as _linting_.
107+
108+
Initialize Git hooks that call the linting scripts for working with the repository by running:
107109

108110
```
109111
go-task -d ~/solus-packages init
110112
```
111113

112-
This makes it easy to create commits in the correct format, and will warn you about issues with changes you commit.
114+
Using git hooks means that linting happens automatically whenever you try to commit changes.
115+
116+
Thus, this makes it easy to create commits in the correct format, and will warn you about issues with changes you commit.
113117

114118
## Set up repository helper functions (optional)
115119

0 commit comments

Comments
 (0)