Follow Git best practices: use imperative mood, and try to limit it to 50 characters or so.
Instead of a simple sentence, prefer to use a Linux-style component prefix:
<name>: <comment>
| #!/bin/sh | |
| # ake 1.0: build system agnostic utility for invoking project build scripts. | |
| # | |
| # Usage: | |
| # - Install this script on PATH as 'ake'. | |
| # - Create an executable 'akefile' and add it your project directory. | |
| # | |
| # Copyright 2025 Timo Savola | |
| # SPDX-License-Identifier: BSD-3-Clause |
| data:text/html,<link rel=icon href=data:image/x-icon,><style>*{background:black}<body> |
| #!/bin/sh | |
| # | |
| # Installation instructions: | |
| # - go get golang.org/x/lint/golint | |
| # - go get github.com/tsavola/golintapi | |
| # - Copy this script to your local Git repository as .git/hooks/pre-commit | |
| # - chmod +x .git/hooks/pre-commit | |
| # | |
| # Note: this script doesn't abort the commit, just displays warnings. |
| //go:noinline | |
| func TODO(...interface{}) { | |
| _todo() | |
| // panic("TODO") | |
| } | |
| //go:noinline | |
| func _todo() { | |
| funcName := "<unknown function>" | |
| fileName := "<unknown file>" |
| btoa(String.fromCharCode(...new Uint8Array(data))).replace(/\+/g, "-").replace(/\//g, "_") |
| import base64, hashlib, sys; h = hashlib.new("sha384"); h.update(open(sys.argv[1], "rb").read()); print(base64.urlsafe_b64encode(h.digest()).decode()) |
| import functools | |
| class CheckBool: | |
| def __init__(self, value): | |
| assert isinstance(value, bool) | |
| self._value = value | |
| self._checked = False |
| .text | |
| .file "llvm-link" | |
| .hidden main # -- Begin function main | |
| .globl main | |
| .type main,@function | |
| main: # @main | |
| .result i32 | |
| .local i32 | |
| # BB#0: | |
| i32.const $push6=, 0 |
| package main | |
| import ( | |
| "context" | |
| "crypto/tls" | |
| "net" | |
| "time" | |
| ) | |
| func dialContextWithDialer(ctx context.Context, dialer *net.Dialer, network, addr string, config *tls.Config) (*tls.Conn, error) { |