nyancodeid/commit-message-id.md

## commit-message-id.md

      
    Raw
  

              commit-message-id.md
            
          
     Pedoman Commit Message

Kami memiliki aturan yang sangat tepat tentang bagaimana pesan git commit kami dapat diformat. Ini mengarah ke pesan yang lebih mudah dibaca yang mudah diikuti ketika melihat melalui history proyek. Dan juga, kami menggunakan pesan git commit untuk menghasilkan log perubahan pada Angular.
Format Commit Message

Setiap pesan komit terdiri dari header, konten, dan catatan kaki. Judul memiliki format khusus yang mencakup jenis, cakupan, dan subjek:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Header adalah wajib namun cakupan (scope) header adalah opsional.
Setiap baris pesan komit tidak boleh lebih dari 100 karakter! Ini memungkinkan pesan menjadi lebih mudah dibaca di GitHub serta di berbagai alat git.
Footer harus berisi referensi penutup untuk issue jika ada.
Contoh:
docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert (Kembali)

Jika komit mengembalikan komit sebelumnya, komit itu harus dimulai dengan revert: diikuti oleh header komit yang dikembalikan. Di dalam konten seharusnya berbunyi: This reverts commit <hash>. , di mana hash adalah SHA dari komit yang dikembalikan.
Tipe

Harus salah satu dari yang berikut:

build: Perubahan yang memengaruhi sistem build atau dependensi eksternal (contoh cakupan (scope): gulp, broccoli, npm)
ci: Perubahan pada file konfigurasi dan skrip CI kami (contoh cakupan: Circle, BrowserStack, SauceLabs)
docs: perubahan Dokumentasi
feat: Fitur baru
fix: Perbaikan bug
perf: Perubahan kode yang meningkatkan kinerja
refactor: Perubahan kode yang tidak memperbaiki bug atau menambahkan fitur
style: Perubahan yang tidak memengaruhi makna kode (white-space, pemformatan, tidak ada titik koma, etc)
test: Menambahkan tes yang hilang atau mengoreksi tes yang ada

Cakupan (Scope)

Cakupannya haruslah nama paket npm yang terpengaruh (seperti yang dirasakan oleh orang yang membaca changelog yang dihasilkan dari pesan komit).
Berikut ini adalah daftar cakupan yang didukung:

animations
common
compiler
compiler-cli
core
elements
forms
http
language-service
platform-browser
platform-browser-dynamic
platform-server
platform-webworker
platform-webworker-dynamic
router
service-worker
upgrade
zone.js

Saat ini ada beberapa pengecualian untuk aturan "use package name":

packaging: digunakan untuk perubahan yang mengubah tata letak paket npm di semua paket kami, misalnya perubahan path, perubahan package.json dilakukan untuk semua paket, perubahan file / format d.ts, perubahan ke bundel, dll.
changelog: digunakan untuk memperbarui catatan rilis di CHANGELOG.md
docs-infra: digunakan untuk perubahan terkait docs-app (angular.io) dalam direktori /aio repo
ivy: digunakan untuk perubahan Ivy renderer.
ngcc: digunakan untuk perubahan Angular Compatibility Compiler
none/empty string: berguna untuk perubahan style , test dan refactor yang dilakukan di semua paket (misalnya style: add missing semicolons ) dan untuk perubahan dokumen yang tidak terkait dengan paket tertentu (misalnya docs: fix typo in tutorial ).

Subyek

Subjek berisi deskripsi perubahan yang singkat:

gunakan imperatif, present tense: "change" bukan "changed" atau "changes"
jangan menggunakan huruf besar untuk huruf pertama
tidak ada titik (.) di akhir

Konten

Sama seperti dalam subjek , gunakan imperatif, present tense: "change" bukan "changed" atau "changes". Konten harus memasukkan motivasi untuk perubahan dan membandingkannya dengan perilaku sebelumnya.
Catatan Kaki (Footer)

Footer harus berisi informasi apa pun tentang Melanggar Perubahan dan juga merupakan tempat untuk merujuk masalah GitHub yang dilakukan diakhir pesan komit.
Breaking Changes harus dimulai dengan kata BREAKING CHANGE: dengan spasi atau dua baris baru. Sisa pesan komit kemudian digunakan untuk ini.
Penjelasan terperinci dapat ditemukan dalam [dokumen][https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit].

  
## commit-message.md

      
    Raw
  

              commit-message.md
            
          
     Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted.  This leads to more
readable messages that are easy to follow when looking through the project history.  But also,
we use the git commit messages to generate the Angular change log.
Commit Message Format

Each commit message consists of a header, a body and a footer.  The header has a special
format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
Samples: (even more samples)
docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Type

Must be one of the following:

build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
docs: Documentation only changes
feat: A new feature
fix: A bug fix
perf: A code change that improves performance
refactor: A code change that neither fixes a bug nor adds a feature
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test: Adding missing tests or correcting existing tests

Scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
The following is the list of supported scopes:

animations
common
compiler
compiler-cli
core
elements
forms
http
language-service
platform-browser
platform-browser-dynamic
platform-server
platform-webworker
platform-webworker-dynamic
router
service-worker
upgrade
zone.js

There are currently a few exceptions to the "use package name" rule:

packaging: used for changes that change the npm package layout in all of our packages, e.g.
public path changes, package.json changes done to all packages, d.ts file/format changes, changes
to bundles, etc.
changelog: used for updating the release notes in CHANGELOG.md
docs-infra: used for docs-app (angular.io) related changes within the /aio directory of the
repo
ivy: used for changes to the Ivy renderer.
ngcc: used for changes to the Angular Compatibility Compiler
none/empty string: useful for style, test and refactor changes that are done across all
packages (e.g. style: add missing semicolons) and for docs changes that are not related to a
specific package (e.g. docs: fix typo in tutorial).

Subject

The subject contains a succinct description of the change:

use the imperative, present tense: "change" not "changed" nor "changes"
don't capitalize the first letter
no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.
Footer

The footer should contain any information about Breaking Changes and is also the place to
reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this [document][https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit].