Skip to content

prepare-for-packaging: Explicitly mention linting #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidjharder merged 1 commit into from
Feb 15, 2025
Merged

prepare-for-packaging: Explicitly mention linting #602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/packaging/prepare-for-packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,19 @@ Create a local clone of the package repository you just forked. Here we are usin
gh repo clone packages ~/solus-packages
```

## Initialize git hooks
## Initialize git hooks for linting

Initialize Git hooks for working with the repository by running:
The process of checking whether package recipes have issues is sometimes referred to as _linting_.

Initialize Git hooks that call the linting scripts for working with the repository by running:

```
go-task -d ~/solus-packages init
```

This makes it easy to create commits in the correct format, and will warn you about issues with changes you commit.
Using git hooks means that linting happens automatically whenever you try to commit changes.

Thus, this makes it easy to create commits in the correct format, and will warn you about issues with changes you commit.

## Set up repository helper functions (optional)

Expand Down