Conventional Commits ਸਹਾਇਕ ਬਾਰੇ — ਵਿਸਤ੍ਰਿਤ ਗਾਈਡ
Conventional Commit Generator Conventional Commits ਨਿਰਧਾਰਨ ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹੋਏ ਢਾਂਚਾਗਤ Git ਕਮਿਟ ਸੁਨੇਹੇ ਬਣਾਉਂਦਾ ਹੈ। ਇਹ Type, Scope, Subject ਲਾਈਨ, ਵਿਕਲਪਿਕ Body ਵੇਰਵਾ, ਅਤੇ Footer ਮੁੱਦਿਆਂ ਨੂੰ ਚੁਣਨ ਵਿੱਚ ਡਿਵੈਲਪਰਾਂ ਦੀ ਅਗਵਾਈ ਕਰਦਾ ਹੈ।
ਵਿਸਮਿਕ ਚਿੰਨ੍ਹ ਸੰਟੈਕਸ (`type!: description`) ਨਾਲ ਬ੍ਰੇਕਿੰਗ ਤਬਦੀਲੀਆਂ ਨੂੰ ਆਸਾਨੀ ਨਾਲ ਫਲੈਗ ਕਰੋ, ਬੰਦ ਕੀਤੇ ਮੁੱਦਿਆਂ ਦਾ ਹਵਾਲਾ ਦਿਓ (`Closes #123`), ਅਤੇ ਮਿਆਰੀ ਕਮਿਟ ਸੁਨੇਹੇ ਤਿਆਰ ਕਰੋ ਜੋ `semantic-release` ਅਤੇ ਆਟੋਮੈਟਿਕ ਚੇਂਜਲੌਗ ਜਨਰੇਟਰਾਂ ਵਰਗੇ ਸਵੈਚਾਲਿਤ ਟੂਲਿੰਗ ਨੂੰ ਸਮਰੱਥ ਬਣਾਉਂਦੇ ਹਨ।
ਮੁੱਖ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਅਤੇ ਸਮਰੱਥਾਵਾਂ
- ਪੂਰਾ ਕਿਸਮ (type) ਕੈਟਾਲਾਗ: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
- ਵਿਕਲਪਿਕ ਸਕੋਪ ਇਨਪੁੱਟ ਅਤੇ ਰੀਅਲ-ਟਾਈਮ ਵਿਸ਼ਾ ਲੰਬਾਈ / ਜ਼ਰੂਰੀ ਵਾਕਾਂਸ਼ (imperative phrasing) ਰੀਮਾਈਂਡਰ
- ਮਿਆਰੀ ਵਿਸਮਿਕ ਚਿੰਨ੍ਹ (`!`) ਸੰਟੈਕਸ ਲਾਗੂ ਕਰਨ ਵਾਲਾ ਇੱਕ-ਕਲਿੱਕ Breaking Change ਟੌਗਲ
- ਇੱਕ-ਕਲਿੱਕ `git commit -m` ਕਾਪੀ ਕਰਨ ਦੇ ਨਾਲ ਆਟੋਮੈਟਿਕ ਮੁੱਦਾ ਲਿੰਕਿੰਗ ਫੁੱਟਰ ਜਨਰੇਟਰ
ਵਰਤੋਂ ਕਿਵੇਂ ਕਰੀਏ
- 1
ਕਮਿਟ ਕਿਸਮ ਚੁਣੋ (ਜਿਵੇਂ ਕਿ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਲਈ `feat`, ਬੱਗ ਸੁਧਾਰਾਂ ਲਈ `fix`)।
- 2
ਇੱਕ ਵਿਕਲਪਿਕ ਸਕੋਪ (ਜਿਵੇਂ ਕਿ `api`, `auth`) ਅਤੇ ਇੱਕ ਸੰਖੇਪ ਹੁਕਮੀਆ (imperative) ਵੇਰਵਾ ਪ੍ਰਦਾਨ ਕਰੋ।
- 3
ਇਕੱਠੀ ਕੀਤੀ ਕਮਿਟ ਸਟ੍ਰਿੰਗ ਦੀ ਸਮੀਖਿਆ ਕਰੋ ਅਤੇ ਆਪਣੇ ਟਰਮੀਨਲ ਲਈ ਪੂਰੀ `git commit` ਕਮਾਂਡ ਕਾਪੀ ਕਰੋ।
ਆਮ ਵਰਤੋਂ ਦੇ ਮਾਮਲੇ
- → ਇੰਜੀਨੀਅਰਿੰਗ ਟੀਮਾਂ ਨੂੰ ਇਕਸਾਰ Git ਕਮਿਟ ਇਤਿਹਾਸ ਮਿਆਰਾਂ 'ਤੇ ਆਨਬੋਰਡ ਕਰਨਾ
- → CI/CD ਪਾਈਪਲਾਈਨਾਂ ਨਾਲ ਸਿਮੈਂਟਿਕ ਵਰਜਨ ਬੰਪਸ ਅਤੇ ਆਟੋਮੈਟਿਕ ਰੀਲੀਜ਼ ਨੋਟਸ ਨੂੰ ਆਟੋਮੇਟ ਕਰਨਾ
- → ਵੱਡੇ ਲਾਇਬ੍ਰੇਰੀ ਅੱਪਡੇਟਾਂ ਦੌਰਾਨ ਪਿਛੜੇ-ਅਸੰਗਤ (backward-incompatible) API ਬ੍ਰੇਕਿੰਗ ਬਦਲਾਵਾਂ ਨੂੰ ਫਲੈਗ ਕਰਨਾ
ਸਬੰਧਤ ਟੂਲ
SEO ਅਤੇ ਸੋਸ਼ਲ ਮੈਟਾ ਟੈਗ ਜਨਰੇਟਰ
ਖੋਜ ਇੰਜਣਾਂ ਅਤੇ ਸੋਸ਼ਲ ਨੈੱਟਵਰਕਾਂ ਲਈ Open Graph, Twitter Cards ਅਤੇ ਜ਼ਰੂਰੀ SEO ਮੈਟਾ ਟੈਗ ਤਿਆਰ ਕਰੋ।
.gitignore ਫਾਈਲ ਜਨਰੇਟਰ
Node.js, Python, Java, Go, Rust, macOS, Windows ਅਤੇ ਦਰਜਨਾਂ ਵਾਤਾਵਰਣਾਂ ਲਈ .gitignore ਫਾਈਲਾਂ ਤਿਆਰ ਕਰੋ।
ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ ਜਨਰੇਟਰ
ਆਪਣੇ ਨਾਮ ਅਤੇ ਸਾਲ ਨਾਲ ਮਿਆਰੀ ਓਪਨ ਸੋਰਸ ਲਾਇਸੈਂਸ (MIT, Apache 2.0, GPL v3, BSD) ਤਿਆਰ ਕਰੋ।
README.md ਫਾਈਲ ਜਨਰੇਟਰ
ਬੈਜ, ਸਥਾਪਨਾ ਨਿਰਦੇਸ਼ਾਂ ਅਤੇ ਸੈਕਸ਼ਨਾਂ ਦੇ ਨਾਲ GitHub ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਪੇਸ਼ੇਵਰ README ਦਸਤਾਵੇਜ਼ ਬਣਾਓ।
SemVer ਕੈਲਕੁਲੇਟਰ ਅਤੇ ਤੁਲਨਾਕਾਰ
ਸਿਮੈਂਟਿਕ ਵਰਜ਼ਨ (SemVer) ਦੀ ਪੁਸ਼ਟੀ ਕਰੋ, ਵਰਜਨਾਂ ਦੀ ਤੁਲਨਾ ਕਰੋ ਅਤੇ ਅਗਲੇ ਵਰਜਨ ਵਾਧੇ (major, minor, patch) ਦੀ ਗਣਨਾ ਕਰੋ।
OpenAPI / Swagger ਦਰਸ਼ਕ
ਬ੍ਰਾਊਜ਼ਰ ਵਿੱਚ ਸਿੱਧੇ OpenAPI ਅਤੇ Swagger API ਦਸਤਾਵੇਜ਼ਾਂ (YAML/JSON) ਨੂੰ ਇੰਟਰਐਕਟਿਵ ਤਰੀਕੇ ਨਾਲ ਵੇਖੋ ਅਤੇ ਟੈਸਟ ਕਰੋ।
ਅਕਸਰ ਪੁੱਛੇ ਜਾਣ ਵਾਲੇ ਸਵਾਲ ਅਤੇ ਪਰਦੇਦਾਰੀ
ਹਰੇਕ ਕਮਿਟ ਕਿਸਮ ਨਾਲ ਕਿਹੜਾ ਸਿਮੈਂਟਿਕ ਵਰਜਨ ਬੰਪ ਮੇਲ ਖਾਂਦਾ ਹੈ?
ਮਿਆਰੀ Conventional Commits ਪਰੰਪਰਾਵਾਂ ਦੇ ਤਹਿਤ, `fix` ਇੱਕ PATCH ਬੰਪ ਨੂੰ ਟਰਿੱਗਰ ਕਰਦਾ ਹੈ, `feat` ਇੱਕ MINOR ਬੰਪ ਨੂੰ ਟਰਿੱਗਰ ਕਰਦਾ ਹੈ, ਅਤੇ `BREAKING CHANGE` ਵਾਲਾ ਕੋਈ ਵੀ ਕਮਿਟ MAJOR ਬੰਪ ਨੂੰ ਟਰਿੱਗਰ ਕਰਦਾ ਹੈ।
ਕੀ ਵਿਸ਼ਾ (subject) ਲਾਈਨ ਦੇ ਅੰਤ ਵਿੱਚ ਪੂਰਨ ਵਿਰਾਮ (period) ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ?
ਨਹੀਂ। Conventional Commits ਦੇ ਸਭ ਤੋਂ ਵਧੀਆ ਅਭਿਆਸ ਬਿਨਾਂ ਪੂਰਨ ਵਿਰਾਮ ਦੇ ਇੱਕ ਸੰਖੇਪ ਹੁਕਮੀਆ ਵਾਕ ਦੀ ਸਿਫ਼ਾਰਸ਼ ਕਰਦੇ ਹਨ (ਜਿਵੇਂ ਕਿ, `feat: allow user avatar upload`)।