Sep
OCT
Nov
09
2019
2020
2021
About this capture
Organization:
Internet Archive
Focused crawls are collections of frequently-updated webcrawl data from narrow (as opposed to broad or wide) web crawls, often focused on a single domain or subdomain.
T h e W a y b a c k M a c h i n e - h t t p : / / w e b . a r c h i v e . o r g / w e b / 2 0 2 0 1 0 0 9 2 2 2 9 4 4 / h t t p s : / / g i t h u b . c o m / c o m m i t i z e n / c z - c l i
S k i p t o c o n t e n t
/ ; r e f _ c t a : S i g n u p ; r e f _ l o c : h e a d e r l o g g e d o u t " >
S i g n up
●
F e a t u r e s →
● C o d e r e v i e w
● P r o j e c t m a n a g e m e n t
● I n t e g r a t i o n s
● A c t i o n s
● P a c k a g e s
● S e c u r i t y
● T e a m m a n a g e m e n t
● H o s t i n g
● M o b i l e
● C u s t o m e r s t o r i e s →
● S e c u r i t y →
●
●
●
● E x p l o r e G i t H u b →
L e a r n & c o n t r i b u t e
● T o p i c s
● C o l l e c t i o n s
● T r e n d i n g
● L e a r n i n g L a b
● O p e n s o u r c e g u i d e s
C o n n e c t w i t h o t h e r s
● E v e n t s
● C o m m u n i t y f o r u m
● G i t H u b E d u c a t i o n
● G i t H u b S t a r s p r o g r a m
●
●
P l a n s →
● C o m p a r e p l a n s
● C o n t a c t S a l e s
● N o n p r o f i t →
● E d u c a t i o n →
In this repository
All GitHub
↵
Jump to
↵
No suggested jump to results
{ { m e s s a g e } }
●
W a t c h
75
●
S t a r
9 . 9 k
●
F o r k
4 0 7
T h e c o m m i t i z e n c o m m a n d l i n e u t i l i t y . # B l a c k L i v e s M a t t e r
c o m m i t i z e n . g i t h u b . i o / c z - c l i /
M I T L i c e n s e
9 . 9 k
s t a r s
4 0 7
f o r k s
S t a r
W a t c h
●
C o d e
●
I s s u e s
1 0 8
●
P u l l r e q u e s t s
25
●
A c t i o n s
●
P r o j e c t s
0
●
S e c u r i t y
●
I n s i g h t s
M o r e
●
C o d e
●
I s s u e s
●
P u l l r e q u e s t s
●
A c t i o n s
●
P r o j e c t s
●
S e c u r i t y
●
I n s i g h t s
D i s m i s s
J o i n G i t H u b t o d a y
G i t H u b i s h o m e t o o v e r 5 0 m i l l i o n d e v e l o p e r s w o r k i n g t o g e t h e r t o h o s t a n d r e v i e w c o d e , m a n a g e p r o j e c t s , a n d b u i l d s o f t w a r e t o g e t h e r .
S i g n u p
40
b r a n c h e s
71
t a g s
G o t o f i l e
C o d e
C l o n e
U s e G i t o r c h e c k o u t w i t h S V N u s i n g t h e w e b U R L .
W o r k f a s t w i t h o u r o f f i c i a l C L I .
L e a r n m o r e .
●
O p e n w i t h G i t H u b D e s k t o p
●
D o w n l o a d Z I P
L a u n c h i n g G i t H u b D e s k t o p
I f n o t h i n g h a p p e n s , d o w n l o a d G i t H u b D e s k t o p a n d t r y a g a i n .
G o b a c k
L a u n c h i n g G i t H u b D e s k t o p
I f n o t h i n g h a p p e n s , d o w n l o a d G i t H u b D e s k t o p a n d t r y a g a i n .
G o b a c k
L a u n c h i n g X c o d e
I f n o t h i n g h a p p e n s , d o w n l o a d X c o d e a n d t r y a g a i n .
G o b a c k
L a u n c h i n g V i s u a l S t u d i o
I f n o t h i n g h a p p e n s , d o w n l o a d t h e G i t H u b e x t e n s i o n f o r V i s u a l S t u d i o a n d t r y a g a i n .
G o b a c k
L a t e s t c o m m i t
d m w e l c h
a n d
D a v e W e l c h
" c l a s s = " l i n k - g r a y - d a r k " h r e f = " / w e b / 2 0 2 0 1 0 0 9 2 2 2 9 4 4 / h t t p s : / / g i t h u b . c o m / c o m m i t i z e n / c z - c l i / c o m m i t / b a 7 e e b 6 7 c 4 d 3 3 4 7 c c 2 3 6 9 f f 6 5 3 8 d 9 d 9 7 7 6 1 c e d c 8 " > c h o r e ( r e n o v a t e ) : I n i t i a l e n h a n c e d c o n f i g u r a t i o n ( # 7 8 6 " c l a s s = " l i n k - g r a y - d a r k " h r e f = " / w e b / 2 0 2 0 1 0 0 9 2 2 2 9 4 4 / h t t p s : / / g i t h u b . c o m / c o m m i t i z e n / c z - c l i / c o m m i t / b a 7 e e b 6 7 c 4 d 3 3 4 7 c c 2 3 6 9 f f 6 5 3 8 d 9 d 9 7 7 6 1 c e d c 8 " > )
…
b a 7 e e b 6
S e p 2 5 , 2 0 2 0
c h o r e ( r e n o v a t e ) : I n i t i a l e n h a n c e d c o n f i g u r a t i o n ( # 7 8 6 )
* chore(renovate): Automate dependency maintenance
* chore(renovate): Update Github path to org
Co-authored-by: Dave Welch <david.welch@monsanto.com>
b a 7 e e b 6
G i t s t a t s
●
3 2 8
c o m m i t s
F i l e s
P e r m a l i n k
F a i l e d t o l o a d l a t e s t c o m m i t i n f o r m a t i o n .
T y p e
N a m e
L a t e s t c o m m i t m e s s a g e
C o m m i t t i m e
b i n
f i x ( c l i ) : D o n ' t p r i n t e r r o r s t a c k t r a c e i f g i t - c z f a i l e d ( # 4 3 6 ) ( # 4 3 7 )
M a y 2 7 , 2 0 1 7
j o b s
A d d i n g t a s k s t o p u b l i s h t e s t r e s u l t s t o A z u r e P i p e l i n e s ( # 5 9 0 )
J u l 1 9 , 2 0 1 9
m e t a / s c r e e n s h o t s
d o c s ( c l i ) : A d d s c r e e n s h o t o f a d d - c o m m i t
A p r 2 0 , 2 0 1 5
s r c
f e a t ! : u s e c z - c o n v e n t i o n a l - c h a n g e l o g a s d e f a u l t a d a p t e r ( # 7 7 8 )
S e p 2 5 , 2 0 2 0
t e s t
f e a t ! : u s e c z - c o n v e n t i o n a l - c h a n g e l o g a s d e f a u l t a d a p t e r ( # 7 7 8 )
S e p 2 5 , 2 0 2 0
. e d i t o r c o n f i g
c h o r e : a d d a p r o j e c t . e d i t o r c o n f i g ( # 4 5 6 )
O c t 2 7 , 2 0 1 7
. e s l i n t r c
f e a t : D r o p s u p p o r t f o r N o d e . j s < 6 . x , u p d a t e d e p e n d e n c i e s ( # 5 6 6 )
S e p 3 0 , 2 0 1 8
. g i t i g n o r e
f i x ( t e s t i n g ) : u p d a t e b a b e l a n d c o d e c o v e r a g e
M a r 8 , 2 0 1 6
. n p m i g n o r e
f i x ( n p m i g n o r e ) : i g n o r e m o r e u n n e c e s s a r y f i l e s ( # 3 9 3 )
D e c 1 4 , 2 0 1 6
. n p m r c
c h o r e : s a v e n p m d e p e n d e n c i e s w i t h p i n n e d v e r s i o n b y d e f a u l t ( # 2 6 1 )
J u n 1 9 , 2 0 1 6
. t r a v i s . y m l
f i x : b u m p t e s t s t o r e l e a s e ( # 6 5 6 )
J u l 2 0 , 2 0 1 9
C O N T R I B U T I N G . m d
D o c s : U p d a t e s A n g u l a r c o m m i t c o n v e n t i o n s l i n k i n C o n t r i b u t i n g . m d ( # 4 7 2 )
M a y 2 4 , 2 0 1 8
L I C E N S E
r e f a c t o r ( c l i ) : C o m p l e t e l y r e w r i t e c o m m i t i z e n
O c t 1 6 , 2 0 1 5
R E A D M E . m d
f e a t ! : u s e c z - c o n v e n t i o n a l - c h a n g e l o g a s d e f a u l t a d a p t e r ( # 7 7 8 )
S e p 2 5 , 2 0 2 0
a z u r e - p i p e l i n e s . y m l
f i x : u p d a t e a z u r e d e v o p s i m a g e s
A p r 7 , 2 0 2 0
b a b e l . c o n f i g . j s
f i x : m o v e t o b a b e l . c o n f i g . j s
A p r 7 , 2 0 2 0
j s c o n f i g . j s o n
r e f a c t o r ( c l i ) : C o m p l e t e l y r e w r i t e c o m m i t i z e n
O c t 1 6 , 2 0 1 5
p a c k a g e - l o c k . j s o n
f e a t ! : u s e c z - c o n v e n t i o n a l - c h a n g e l o g a s d e f a u l t a d a p t e r ( # 7 7 8 )
S e p 2 5 , 2 0 2 0
p a c k a g e . j s o n
f e a t ! : u s e c z - c o n v e n t i o n a l - c h a n g e l o g a s d e f a u l t a d a p t e r ( # 7 7 8 )
S e p 2 5 , 2 0 2 0
r e n o v a t e . j s o n
" c l a s s = " l i n k - g r a y " h r e f = " / w e b / 2 0 2 0 1 0 0 9 2 2 2 9 4 4 / h t t p s : / / g i t h u b . c o m / c o m m i t i z e n / c z - c l i / c o m m i t / b a 7 e e b 6 7 c 4 d 3 3 4 7 c c 2 3 6 9 f f 6 5 3 8 d 9 d 9 7 7 6 1 c e d c 8 " > c h o r e ( r e n o v a t e ) : I n i t i a l e n h a n c e d c o n f i g u r a t i o n ( # 7 8 6 " c l a s s = " l i n k - g r a y " h r e f = " / w e b / 2 0 2 0 1 0 0 9 2 2 2 9 4 4 / h t t p s : / / g i t h u b . c o m / c o m m i t i z e n / c z - c l i / c o m m i t / b a 7 e e b 6 7 c 4 d 3 3 4 7 c c 2 3 6 9 f f 6 5 3 8 d 9 d 9 7 7 6 1 c e d c 8 " > )
S e p 2 5 , 2 0 2 0
V i e w c o d e
R E A D M E . m d
C o m m i t i z e n f o r c o n t r i b u t o r s
W h e n y o u c o m m i t w i t h C o m m i t i z e n , y o u ' l l b e p r o m p t e d t o f i l l o u t a n y r e q u i r e d c o m m i t f i e l d s a t c o m m i t t i m e . N o m o r e w a i t i n g u n t i l l a t e r f o r a g i t c o m m i t h o o k t o r u n a n d r e j e c t y o u r c o m m i t ( t h o u g h t h a t c a n s t i l l b e h e l p f u l ) . N o m o r e d i g g i n g t h r o u g h C O N T R I B U T I N G . m d t o f i n d w h a t t h e p r e f e r r e d f o r m a t i s . G e t i n s t a n t f e e d b a c k o n y o u r c o m m i t m e s s a g e f o r m a t t i n g a n d b e p r o m p t e d f o r r e q u i r e d f i e l d s .
I n s t a l l i n g t h e c o m m a n d l i n e t o o l
C o m m i t i z e n i s c u r r e n t l y t e s t e d a g a i n s t
n o d e 1 0 a n d 1 2 a l t h o u g h i t m a y w o r k i n
o l d e r n o d e . Y o u s h o u l d a l s o h a v e n p m 6
o r g r e a t e r .
I n s t a l l a t i o n i s a s s i m p l e a s r u n n i n g t h e f o l l o w i n g c o m m a n d ( i f y o u s e e E A C C E S e r r o r , r e a d i n g f i x i n g n p m p e r m i s s i o n s m a y h e l p ) :
npm install -g commitizen
U s i n g t h e c o m m a n d l i n e t o o l
S i m p l y u s e g i t c z o r j u s t cz i n s t e a d o f g i t c o m m i t w h e n c o m m i t t i n g . Y o u c a n a l s o u s e g i t - c z , w h i c h i s a n a l i a s f o r cz .
A l t e r n a t i v e l y , i f y o u a r e u s i n g N P M 5 . 2 + y o u c a n u s e n p x i n s t e a d o f i n s t a l l i n g g l o b a l l y :
npx cz
o r a s a n n p m s c r i p t :
...
" scripts" : {
" commit" : " cz "
}
W h e n y o u ' r e w o r k i n g i n a C o m m i t i z e n f r i e n d l y r e p o s i t o r y , y o u ' l l b e p r o m p t e d t o f i l l i n a n y r e q u i r e d f i e l d s a n d y o u r c o m m i t m e s s a g e s w i l l b e f o r m a t t e d a c c o r d i n g t o t h e s t a n d a r d s d e f i n e d b y p r o j e c t m a i n t a i n e r s .
I f y o u r r e p o i s N O T C o m m i t i z e n - f r i e n d l y
I f y o u ' r e n o t w o r k i n g i n a C o m m i t i z e n f r i e n d l y r e p o s i t o r y , t h e n g i t c z w i l l w o r k j u s t t h e s a m e a s g i t c o m m i t b u t n p x c z w i l l u s e t h e c z - c o n v e n t i o n a l - c h a n g e l o g a d a p t e r . T o f i x t h i s , y o u n e e d t o f i r s t m a k e y o u r r e p o C o m m i t i z e n - f r i e n d l y .
M a k i n g y o u r r e p o C o m m i t i z e n - f r i e n d l y
F o r t h i s e x a m p l e , w e ' l l b e s e t t i n g u p o u r r e p o t o u s e C o n v e n t i o n a l C o m m i t s c o n v e n t i o n t h r o u g h t h e c o n v e n t i o n a l - c h a n g e l o g c o m m i t i z e n a d a p t e r .
F i r s t , i n s t a l l t h e C o m m i t i z e n c l i t o o l s :
npm install commitizen -g
N e x t , i n i t i a l i z e y o u r p r o j e c t t o u s e t h e c z - c o n v e n t i o n a l - c h a n g e l o g a d a p t e r b y t y p i n g :
commitizen init cz-conventional-changelog --save-dev --save-exact
O r i f y o u a r e u s i n g Y a r n :
commitizen init cz-conventional-changelog --yarn --dev --exact
N o t e t h a t i f y o u w a n t t o f o r c e i n s t a l l o v e r t h e t o p o f a n o l d a d a p t e r , y o u c a n a p p l y t h e - - f o r c e a r g u m e n t . F o r m o r e i n f o r m a t i o n o n t h i s , j u s t r u n c o m m i t i z e n h e l p .
T h e a b o v e c o m m a n d d o e s t h r e e t h i n g s f o r y o u .
(一) I n s t a l l s t h e c z - c o n v e n t i o n a l - c h a n g e l o g a d a p t e r n p m m o d u l e
(二) S a v e s i t t o p a c k a g e . j s o n ' s d e p e n d e n c i e s o r d e v D e p e n d e n c i e s
(三) A d d s t h e c o n f i g . c o m m i t i z e n k e y t o t h e r o o t o f y o u r p a c k a g e . j s o n a s s h o w n h e r e :
...
" config" : {
" commitizen" : {
" path" : " cz-conventional-changelog"
}
}
A l t e r n a t i v e l y , c o m m i t i z e n c o n f i g s m a y b e a d d e d t o a . c z r c or . c z . j s o n f i l e :
{
" path" : " cz-conventional-changelog"
}
T h i s j u s t t e l l s C o m m i t i z e n w h i c h a d a p t e r w e a c t u a l l y w a n t o u r c o n t r i b u t o r s t o u s e w h e n t h e y t r y t o c o m m i t t o t h i s r e p o .
c o m m i t i z e n . p a t h i s r e s o l v e d v i a r e q u i r e . r e s o l v e a n d s u p p o r t s
● n p m m o d u l e s
● d i r e c t o r i e s r e l a t i v e t o p r o c e s s . c w d ( ) c o n t a i n i n g a n i n d e x . j s f i l e
● f i l e b a s e n a m e s r e l a t i v e t o p r o c e s s . c w d ( ) w i t h js e x t e n s i o n
● f u l l r e l a t i v e f i l e n a m e s
● a b s o l u t e p a t h s .
P l e a s e n o t e t h a t i n t h e p r e v i o u s v e r s i o n o f C o m m i t i z e n w e u s e d c z C o n f i g . c z C o n f i g h a s b e e n d e p r e c a t e d a n d y o u s h o u l d m i g r a t e t o t h e n e w f o r m a t b e f o r e C o m m i t i z e n 3 . 0 . 0 .
O p t i o n a l : I n s t a l l a n d r u n C o m m i t i z e n l o c a l l y
I n s t a l l i n g a n d r u n n i n g C o m m i t i z e n l o c a l l y a l l o w s y o u t o m a k e s u r e t h a t d e v e l o p e r s a r e r u n n i n g t h e e x a c t s a m e v e r s i o n o f C o m m i t i z e n o n e v e r y m a c h i n e .
I n s t a l l C o m m i t i z e n w i t h n p m i n s t a l l - - s a v e - d e v c o m m i t i z e n .
On N P M 5 . 2 + y o u c a n u s e n p x t o i n i t i a l i z e t h e c o n v e n t i o n a l c h a n g e l o g a d a p t e r :
npx commitizen init cz-conventional-changelog --save-dev --save-exact
F o r p r e v i o u s v e r s i o n s o f N P M ( < 5 . 2 ) y o u c a n e x e c u t e . / n o d e _ m o d u l e s / . b i n / c o m m i t i z e n or . / n o d e _ m o d u l e s / . b i n / c z i n o r d e r t o a c t u a l l y u s e t h e c o m m a n d s .
Y o u c a n t h e n i n i t i a l i z e t h e c o n v e n t i o n a l c h a n g e l o g a d a p t e r u s i n g : . / n o d e _ m o d u l e s / . b i n / c o m m i t i z e n i n i t c z - c o n v e n t i o n a l - c h a n g e l o g - - s a v e - d e v - - s a v e - e x a c t
A n d y o u c a n t h e n a d d s o m e n i c e n p m r u n s c r i p t s i n y o u r p a c k a g e . j s o n p o i n t i n g t o t h e l o c a l v e r s i o n o f c o m m i t i z e n :
...
" scripts" : {
" commit" : " cz "
}
T h i s w i l l b e m o r e c o n v e n i e n t f o r y o u r u s e r s b e c a u s e t h e n i f t h e y w a n t t o d o a c o m m i t , a l l t h e y n e e d t o d o i s r u n n p m r u n c o m m i t a n d t h e y w i l l g e t t h e p r o m p t s n e e d e d t o s t a r t a c o m m i t !
N O T E : i f y o u a r e u s i n g p r e c o m m i t h o o k s t h a n k s t o s o m e t h i n g l i k e h u s k y , y o u w i l l n e e d t o n a m e y o u r s c r i p t s o m e t h i n g o t h e r t h a n " c o m m i t "
( e . g . " c m " : " c z " ) . T h e r e a s o n i s b e c a u s e n p m - s c r i p t s h a s a " f e a t u r e " w h e r e i t a u t o m a t i c a l l y r u n s s c r i p t s w i t h t h e n a m e p r e x x x w h e r e x x x i s t h e n a m e o f a n o t h e r s c r i p t . I n e s s e n c e ,
n p m a n d h u s k y w i l l r u n " p r e c o m m i t " s c r i p t s t w i c e i f y o u n a m e t h e s c r i p t " c o m m i t " , a n d t h e w o r k a r o u n d i s t o p r e v e n t t h e n p m - t r i g g e r e d p r e c o m m i t s c r i p t .
O p t i o n a l : R u n n i n g C o m m i t i z e n o n g i t c o m m i t
T h i s e x a m p l e s h o w s h o w t o i n c o r p o r a t e C o m m i t i z e n i n t o t h e e x i s t i n g g i t c o m m i t w o r k f l o w b y u s i n g g i t h o o k s a n d t h e - - h o o k c o m m a n d - l i n e o p t i o n . T h i s i s u s e f u l f o r p r o j e c t m a i n t a i n e r s
w h o w i s h t o e n s u r e t h e p r o p e r c o m m i t f o r m a t i s e n f o r c e d o n c o n t r i b u t i o n s f r o m t h o s e u n f a m i l i a r w i t h C o m m i t i z e n .
O n c e e i t h e r o f t h e s e m e t h o d s i s i m p l e m e n t e d , u s e r s r u n n i n g g i t c o m m i t w i l l b e p r e s e n t e d w i t h a n i n t e r a c t i v e C o m m i t i z e n s e s s i o n t h a t h e l p s t h e m w r i t e u s e f u l c o m m i t m e s s a g e s .
N O T E : T h i s e x a m p l e a s s u m e s t h a t t h e p r o j e c t h a s b e e n s e t u p t o u s e C o m m i t i z e n l o c a l l y .
T r a d i t i o n a l g i t h o o k s
U p d a t e . g i t / h o o k s / p r e p a r e - c o m m i t - m s g w i t h t h e f o l l o w i n g c o d e :
#! /bin/bash
exec < /dev/tty && node_modules/.bin/cz --hook || true
H u s k y
F o r h u s k y u s e r s , a d d t h e f o l l o w i n g c o n f i g u r a t i o n t o t h e p r o j e c t ' s p a c k a g e . j s o n :
" husky" : {
" hooks" : {
" prepare-commit-msg" : " exec < /dev/tty && git cz --hook || true" ,
}
}
W h y e x e c < / d e v / t t y ? B y d e f a u l t , g i t h o o k s a r e n o t i n t e r a c t i v e . T h i s c o m m a n d a l l o w s t h e u s e r t o u s e t h e i r t e r m i n a l t o i n t e r a c t w i t h C o m m i t i z e n d u r i n g t h e h o o k .
C o n g r a t u l a t i o n s y o u r r e p o i s C o m m i t i z e n - f r i e n d l y . T i m e t o f l a u n t i t !
A d d t h e C o m m i t i z e n - f r i e n d l y b a d g e t o y o u r R E A D M E u s i n g t h e f o l l o w i n g m a r k d o w n :
[](http://commitizen.github.io/cz-cli/)
Y o u r b a d g e w i l l l o o k l i k e t h i s :
I t m a y a l s o m a k e s e n s e t o c h a n g e y o u r R E A D M E . m d o r C O N T R I B U T I N G . m d t o i n c l u d e o r l i n k t o t h e C o m m i t i z e n p r o j e c t s o t h a t y o u r n e w c o n t r i b u t o r s m a y l e a r n m o r e a b o u t i n s t a l l i n g a n d u s i n g C o m m i t i z e n .
C o n v e n t i o n a l c o m m i t m e s s a g e s a s a g l o b a l u t i l i t y
I n s t a l l c o m m i t i z e n g l o b a l l y , i f y o u h a v e n o t a l r e a d y .
npm install -g commitizen
I n s t a l l y o u r p r e f e r r e d c o m m i t i z e n a d a p t e r g l o b a l l y , f o r e x a m p l e c z - c o n v e n t i o n a l - c h a n g e l o g
npm install -g cz-conventional-changelog
C r e a t e a . c z r c f i l e i n y o u r h o m e d i r e c t o r y , w i t h p a t h r e f e r r i n g t o t h e p r e f e r r e d , g l o b a l l y i n s t a l l e d , c o m m i t i z e n a d a p t e r
echo ' { "path": "cz-conventional-changelog" }' > ~ /.czrc
Y o u a r e a l l s e t ! N o w cd i n t o a n y g i t r e p o s i t o r y a n d u s e g i t c z i n s t e a d o f g i t c o m m i t a n d y o u w i l l f i n d t h e c o m m i t i z e n p r o m p t .
P r o t i p : Y o u c a n u s e a l l t h e g i t c o m m i t o p t i o n s w i t h g i t c z , f o r e x a m p l e : g i t c z - a .
I f y o u r r e p o s i t o r y i s a n o d e j s p r o j e c t , m a k i n g i t C o m m i t i z e n - f r i e n d l y i s s u p e r e a s y .
I f y o u r r e p o s i t o r y i s a l r e a d y C o m m i t i z e n - f r i e n d l y , t h e l o c a l c o m m i t i z e n a d a p t e r w i l l b e u s e d , i n s t e a d o f g l o b a l l y i n s t a l l e d o n e .
C o m m i t i z e n f o r m u l t i - r e p o p r o j e c t s
A s a p r o j e c t m a i n t a i n e r o f m a n y p r o j e c t s , y o u m a y w a n t t o s t a n d a r d i z e o n a s i n g l e c o m m i t m e s s a g e
f o r m a t f o r a l l o f t h e m . Y o u c a n c r e a t e y o u r o w n n o d e m o d u l e w h i c h a c t s a s f r o n t - e n d f o r c o m m i t i z e n .
1 . C r e a t e y o u r o w n e n t r y p o i n t s c r i p t
// my-cli.js
#!/usr/bin/env node
"use strict" ;
const path = require ( 'path' ) ;
const bootstrap = require ( 'commitizen/dist/cli/git-cz' ) . bootstrap ;
bootstrap ( {
cliPath : path . join ( __dirname , '../../node_modules/commitizen' ) ,
// this is new
config : {
"path" : "cz-conventional-changelog"
}
} ) ;
2 . A d d s c r i p t t o p a c k a g e . j s o n
// package.json
{
" name" : " company-commit" ,
" bin" : " ./my-cli.js" ,
" dependencies" : {
" commitizen" : " ^2.7.6" ,
" cz-conventional-changelog" : " ^1.1.5" ,
}
}
3 . P u b l i s h i t t o n p m a n d u s e i t !
npm install --save-dev company-commit
./node_modules/.bin/company-commit
A d a p t e r s
W e k n o w t h a t e v e r y p r o j e c t a n d b u i l d p r o c e s s h a s d i f f e r e n t r e q u i r e m e n t s s o w e ' v e t r i e d t o k e e p C o m m i t i z e n o p e n f o r e x t e n s i o n . Y o u c a n d o t h i s b y c h o o s i n g f r o m a n y o f t h e p r e - b u i l d a d a p t e r s o r e v e n b y b u i l d i n g y o u r o w n . H e r e a r e s o m e o f t h e g r e a t a d a p t e r s a v a i l a b l e t o y o u :
● c z - c o n v e n t i o n a l - c h a n g e l o g
● c z - c o n v e n t i o n a l - c h a n g e l o g - f o r - j i r a
● c z - c o n v e n t i o n a l - c h a n g e l o g - w i t h - j i r a i d - d e t e c t i o n
● c z - j i r a - s m a r t - c o m m i t
● @ e n d e m o l s h i n e g r o u p / c z - j i r a - s m a r t - c o m m i t
● @ e n d e m o l s h i n e g r o u p / c z - g i t h u b
● r b - c o n v e n t i o n a l - c h a n g e l o g
● c z - m a p b o x - c h a n g e l o g
● c z - c u s t o m i z a b l e
● c o m m i t l i n t
● v s c o d e - c o m m i t i z e n
● c z - e m o j i
● c z - a d a p t e r - e s l i n t
● c o m m i t i q u e t t e
● c z - f o r m a t - e x t e n s i o n
T o c r e a t e a n a d a p t e r , j u s t f o r k o n e o f t h e s e g r e a t a d a p t e r s a n d m o d i f y i t t o s u i t y o u r n e e d s . W e p a s s y o u a n i n s t a n c e o f I n q u i r e r . j s b u t y o u c a n c a p t u r e i n p u t u s i n g w h a t e v e r m e a n s n e c e s s a r y . J u s t c a l l t h e c o m m i t c a l l b a c k w i t h a s t r i n g a n d w e ' l l b e h a p p y . P u b l i s h i t t o n p m , a n d y o u ' l l b e a l l s e t !
R e t r y i n g f a i l e d c o m m i t s
A s o f v e r s i o n 2 . 7 . 1 , y o u m a y a t t e m p t t o r e t r y t h e l a s t c o m m i t u s i n g t h e g i t c z - - r e t r y c o m m a n d . T h i s c a n b e h e l p f u l w h e n y o u h a v e t e s t s s e t u p t o r u n v i a a g i t p r e c o m m i t h o o k . I n t h i s s c e n a r i o , y o u m a y h a v e a t t e m p t e d a C o m m i t i z e n c o m m i t , p a i n s t a k i n g l y f i l l e d o u t a l l o f t h e c o m m i t i z e n f i e l d s , b u t y o u r t e s t s f a i l . I n p r e v i o u s C o m m i t i z e n v e r s i o n s , a f t e r f i x i n g y o u r t e s t s , y o u w o u l d b e f o r c e d t o f i l l o u t a l l o f t h e f i e l d s a g a i n . E n t e r t h e r e t r y c o m m a n d . C o m m i t i z e n w i l l r e t r y t h e l a s t c o m m i t t h a t y o u a t t e m p t e d i n t h i s r e p o w i t h o u t y o u n e e d i n g t o f i l l o u t t h e f i e l d s a g a i n .
P l e a s e n o t e t h a t t h e r e t r y c a c h e m a y b e c l e a r e d w h e n u p g r a d i n g c o m m i t i z e n v e r s i o n s , u p g r a d i n g a d a p t e r s , o r i f y o u d e l e t e t h e c o m m i t i z e n . j s o n f i l e i n y o u r h o m e o r t e m p d i r e c t o r y . A d d i t i o n a l l y , t h e c o m m i t c a c h e u s e s t h e f i l e s y s t e m p a t h o f t h e r e p o , s o i f y o u m o v e a r e p o o r c h a n g e i t s p a t h , y o u w i l l n o t b e a b l e t o r e t r y a c o m m i t . T h i s i s a n e d g e c a s e , b u t m i g h t b e c o n f u s i n g i f y o u h a v e s c e n a r i o s w h e r e y o u a r e m o v i n g f o l d e r s t h a t c o n t a i n r e p o s .
I t i s i m p o r t a n t t o n o t e t h a t i f y o u a r e r u n n i n g cz f r o m a n p m s c r i p t ( l e t ' s s a y i t i s c a l l e d c o m m i t ) y o u w i l l n e e d t o d o o n e o f t h e f o l l o w i n g :
● P a s s - - - - r e t r y a s a n a r g u m e n t f o r y o u r s c r i p t . i . e : n p m r u n c o m m i t - - - - r e t r y
● U s e n p x t o f i n d a n d c a l l cz e x e c u t a b l e d i r e c t l y . i . e : n p x c z - - r e t r y
N o t e t h a t t h e l a s t t w o o p t i o n s d o n o t r e q u i r e y o u t o p a s s - - b e f o r e t h e a r g s b u t t h e f i r s t d o e s .
C o m m i t i z e n f o r p r o j e c t m a i n t a i n e r s
A s a p r o j e c t m a i n t a i n e r , m a k i n g y o u r r e p o C o m m i t i z e n f r i e n d l y a l l o w s y o u t o s e l e c t p r e - e x i s t i n g c o m m i t m e s s a g e c o n v e n t i o n s o r t o c r e a t e y o u r o w n c u s t o m c o m m i t m e s s a g e c o n v e n t i o n . W h e n a c o n t r i b u t o r t o y o u r r e p o u s e s C o m m i t i z e n , t h e y w i l l b e p r o m p t e d f o r t h e c o r r e c t f i e l d s a t c o m m i t t i m e .
G o f u r t h e r
C o m m i t i z e n i s g r e a t o n i t s o w n , b u t i t s h i n e s w h e n y o u u s e i t w i t h s o m e o t h e r a m a z i n g o p e n s o u r c e t o o l s . K e n t C . D o d d s s h o w s y o u h o w t o a c c o m p l i s h t h i s i n h i s E g g h e a d . i o s e r i e s , H o w t o w r i t e a n o p e n s o u r c e j a v a s c r i p t l i b r a r y . M a n y o f t h e c o n c e p t s c a n b e a p p l i e d t o n o n - j a v a s c r i p t p r o j e c t s a s w e l l .
P h i l o s o p h y
A b o u t C o m m i t i z e n
C o m m i t i z e n i s a n o p e n s o u r c e p r o j e c t t h a t h e l p s c o n t r i b u t o r s b e g o o d o p e n s o u r c e c i t i z e n s . I t a c c o m p l i s h e s t h i s b y p r o m p t i n g t h e m t o f o l l o w c o m m i t m e s s a g e c o n v e n t i o n s a t c o m m i t t i m e . I t a l s o e m p o w e r s p r o j e c t m a i n t a i n e r s t o c r e a t e o r u s e p r e d e f i n e d c o m m i t m e s s a g e c o n v e n t i o n s i n t h e i r r e p o s t o b e t t e r c o m m u n i c a t e t h e i r e x p e c t a t i o n s t o p o t e n t i a l c o n t r i b u t o r s .
C o m m i t i z e n o r C o m m i t H o o k s
B o t h ! C o m m i t i z e n i s n o t m e a n t t o b e a r e p l a c e m e n t f o r g i t c o m m i t h o o k s . R a t h e r , i t i s m e a n t t o w o r k s i d e - b y - s i d e w i t h t h e m t o e n s u r e a c o n s i s t e n t a n d p o s i t i v e e x p e r i e n c e f o r y o u r c o n t r i b u t o r s . C o m m i t i z e n t r e a t s t h e c o m m i t c o m m a n d a s a d e c l a r a t i v e a c t i o n . T h e c o n t r i b u t o r i s d e c l a r i n g t h a t t h e y w i s h t o c o n t r i b u t e t o y o u r p r o j e c t . I t i s u p t o y o u a s t h e m a i n t a i n e r t o d e f i n e w h a t r u l e s t h e y s h o u l d b e f o l l o w i n g .
W e a c c o m p l i s h t h i s b y l e t t i n g y o u d e f i n e w h i c h a d a p t e r y o u ' d l i k e t o u s e i n y o u r p r o j e c t . A d a p t e r s j u s t a l l o w m u l t i p l e p r o j e c t s t o s h a r e t h e s a m e c o m m i t m e s s a g e c o n v e n t i o n s . A g o o d e x a m p l e o f a n a d a p t e r i s t h e c z - c o n v e n t i o n a l - c h a n g e l o g a d a p t e r .
R e l a t e d p r o j e c t s
● c o n v e n t i o n a l - c h a n g e l o g – G e n e r a t e a c h a n g e l o g f r o m c o n v e n t i o n a l c o m m i t h i s t o r y
● c o m m i t l i n t - L i n t c o m m i t m e s s a g e s
A u t h o r s a n d C o n t r i b u t o r s
@ J i m T h e D e v ( J i m C u m m i n s , a u t h o r )
@ k e n t c d o d d s
@ a c c r a z e
@ k y t w b
@ D e n - d p
S p e c i a l t h a n k s t o @ s t e v e l a c y , w h o s e g u l p - g i t p r o j e c t m a k e s c o m m i t i z e n p o s s i b l e .
C o n t r i b u t o r s
T h i s p r o j e c t e x i s t s t h a n k s t o a l l t h e p e o p l e w h o c o n t r i b u t e . [ C o n t r i b u t e ] .
B a c k e r s
T h a n k y o u t o a l l o u r b a c k e r s ! 🙏 [ B e c o m e a b a c k e r ]
S p o n s o r s
S u p p o r t t h i s p r o j e c t b y b e c o m i n g a s p o n s o r . Y o u r l o g o w i l l s h o w u p h e r e w i t h a l i n k t o y o u r w e b s i t e . [ B e c o m e a s p o n s o r ]
A b o u t
T h e c o m m i t i z e n c o m m a n d l i n e u t i l i t y . # B l a c k L i v e s M a t t e r
c o m m i t i z e n . g i t h u b . i o / c z - c l i /
T o p i c s
c o m m i t i z e n
j a v a s c r i p t
c o m m i t - h o o k s
n o d e
s e m a n t i c - v e r s i o n i n g
s e m a n t i c - r e l e a s e
c o m m a n d - l i n e
u t i l i t i e s
c o m m i t i z e n - a d a p t e r
g i t
R e s o u r c e s
R e a d m e
L i c e n s e
M I T L i c e n s e
v 4 . 2 . 1
L a t e s t
A u g 2 5 , 2 0 2 0
+ 7 0 r e l e a s e s
N o p a c k a g e s p u b l i s h e d
+ 3 6 , 7 7 6
+ 6 6 c o n t r i b u t o r s
L a n g u a g e s
●
J a v a S c r i p t
1 0 0 . 0 %
● © 2 0 2 0 G i t H u b , I n c .
● T e r m s
● P r i v a c y
●
C o o k i e P r e f e r e n c e s
● S e c u r i t y
● S t a t u s
● H e l p
● C o n t a c t G i t H u b
● P r i c i n g
● A P I
● T r a i n i n g
● B l o g
● A b o u t
Y o u c a n ’ t p e r f o r m t h a t a c t i o n a t t h i s t i m e .
Y o u s i g n e d i n w i t h a n o t h e r t a b o r w i n d o w . R e l o a d t o r e f r e s h y o u r s e s s i o n .
Y o u s i g n e d o u t i n a n o t h e r t a b o r w i n d o w . R e l o a d t o r e f r e s h y o u r s e s s i o n .
W e u s e o p t i o n a l t h i r d - p a r t y a n a l y t i c s c o o k i e s t o u n d e r s t a n d h o w y o u u s e G i t H u b . c o m s o w e c a n b u i l d b e t t e r p r o d u c t s .
L e a r n m o r e .
A c c e p t
R e j e c t
W e u s e o p t i o n a l t h i r d - p a r t y a n a l y t i c s c o o k i e s t o u n d e r s t a n d h o w y o u u s e G i t H u b . c o m s o w e c a n b u i l d b e t t e r p r o d u c t s .
Y o u c a n a l w a y s u p d a t e y o u r s e l e c t i o n b y c l i c k i n g C o o k i e P r e f e r e n c e s a t t h e b o t t o m o f t h e p a g e .
F o r m o r e i n f o r m a t i o n , s e e o u r P r i v a c y S t a t e m e n t .
E s s e n t i a l c o o k i e s
W e u s e e s s e n t i a l c o o k i e s t o p e r f o r m e s s e n t i a l w e b s i t e f u n c t i o n s , e . g . t h e y ' r e u s e d t o l o g y o u i n .
L e a r n m o r e
A l w a y s a c t i v e
A n a l y t i c s c o o k i e s
W e u s e a n a l y t i c s c o o k i e s t o u n d e r s t a n d h o w y o u u s e o u r w e b s i t e s s o w e c a n m a k e t h e m b e t t e r , e . g . t h e y ' r e u s e d t o g a t h e r i n f o r m a t i o n a b o u t t h e p a g e s y o u v i s i t a n d h o w m a n y c l i c k s y o u n e e d t o a c c o m p l i s h a t a s k .
L e a r n m o r e
A c c e p t
R e j e c t
S a v e p r e f e r e n c e s