[GH-ISSUE #3561] [Bug] Update githook helper link #1614

New issue

Closed

opened 2026-03-23 20:51:42 +00:00 by mirror · 1 comment

mirror commented

2026-03-23 20:51:42 +00:00

Owner

Originally created by @AmanNegi on GitHub (Oct 1, 2023).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/3561

Bug Description

When a contributor tries to contribute to AppFlowy, we follow a standard procedure of checking the commit messages. We accordingly provide the user with an helper link which could help the user diagnose the issue and learn further. The link has gone outdated, and it would be nice if it could be updated.

if [ $? -ne 0 ]
then
    printError "Please fix your commit message to match AppFlowy coding standards"
    printError "https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/code-submission-guidelines#commit-message-guidelines"
    exit 1
fi

How to Reproduce

Click here to go to the link.

Create your own branch, and make some changes in file.
Stage the files using git add . and try to commit with an invalid message, like:

made some changes

You will be prompted with an error, use the link provided in the error, and you will be leaded to GitBook docs, where it says Page Not Found.

Expected Behavior

Instead of the outdated link, we should provide the user with the below link:

https://docs.appflowy.io/docs/documentation/software-contributions/conventions/git-conventions

Operating System

Ubuntu

AppFlowy Version(s)

Latest

Originally created by @AmanNegi on GitHub (Oct 1, 2023). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/3561 ### Bug Description When a contributor tries to contribute to AppFlowy, we follow a standard procedure of checking the commit messages. We accordingly provide the user with an helper link which could help the user diagnose the issue and learn further. The link has gone outdated, and it would be nice if it could be updated. ```js if [ $? -ne 0 ] then printError "Please fix your commit message to match AppFlowy coding standards" printError "https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/code-submission-guidelines#commit-message-guidelines" exit 1 fi ``` ### How to Reproduce > Click [here](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/code-submission-guidelines#commit-message-guidelines) to go to the link. <p align="center">OR</p> 1. Create your own branch, and make some changes in file. 2. Stage the files using `git add .` and try to commit with an invalid message, like: > made some changes 3. You will be prompted with an error, use the link provided in the error, and you will be leaded to GitBook docs, where it says Page Not Found. ### Expected Behavior Instead of the outdated link, we should provide the user with the below link: https://docs.appflowy.io/docs/documentation/software-contributions/conventions/git-conventions ### Operating System Ubuntu ### AppFlowy Version(s) Latest