Create shared .gitconfig and .gitmessage with commit message template - #37951
#37951Create shared .gitconfig and .gitmessage with commit message template#37951IgorMinar wants to merge 11 commits intoangular:masterangular/angular:masterfrom IgorMinar:build/shared-.gitconfigIgorMinar/angular:build/shared-.gitconfigCopy head branch name to clipboard
Conversation
2fb533b to
3fafcc6
Compare
pkozlowski-opensource
left a comment
There was a problem hiding this comment.
@IgorMinar I like the idea a lot! Agree with the @petebacondarwin remarks, though, so adding the cleanup label.
There was a problem hiding this comment.
I love the idea (although I couldn't get it to work for me - it may be a Windows thing 😅 Typical PEBCAK situation).
The second commit message makes it sound as if .gitmessage is a special file in git (similar to .gitignore or .gitattributes), but afaict that is not the case. Might be worth rephrasing for clarity.
|
@gkalpak which part didn't work on windows? The shared gitconfig or the template? Both should work on windows as far as I know. |
|
I couldn't get the message template to work 😞 |
|
NVM, I tried it again and now it worked fine. Not sure what I did wrong before. Sorry for the noise 😇 |
602685e to
8b44382
Compare
|
I pushed a bunch more changes. I linked the template to the commit message docs on github and updated them so that the github version is a strict superset of the version in the template that is a bit more succinct. |
8b44382 to
0d08568
Compare
|
Adding @aikidave for contributing guide changes |
aikithoughts
left a comment
There was a problem hiding this comment.
LGTM!
Reviewed-for: global-docs-approvers
…stent git config This file is inert unless it's explicitly included into the local git config via: ``` git config --add include.path '../.ng-dev/gitconfig' ``` Calling that command will append the following into `.git/config` of the current git workspace (i.e. $GIT_DIR, typically `angular/.git/config`): ``` [include] path = ../.ng-dev/gitconfig ``` I'm intentionally keeping the config inert for now until we prove that this is a good idea. Eventually we could roll this change out to all the contributors via an npm post-install script.
Git provides a way to create a commit message template via the `.gitmessage` file. Introduce an Angular-specific .gitmessage template based on the original Commit Message Guidelines. https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines If this template workflow is proven in practice, we can move the commit message guidelines into the .gitmessage file to prevent duplication of the content. This change is a follow up on angular#37949 and is inspired by info found in the following blog post: https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template
This doc is very old and rusty. I'm reformatting it to follow the one-setence-per-line rule. I also updated a few sections, since they were either poorly written or obsolete.
7a04f8f to
74fea3a
Compare
…stent git config (#37951) This file is inert unless it's explicitly included into the local git config via: ``` git config --add include.path '../.ng-dev/gitconfig' ``` Calling that command will append the following into `.git/config` of the current git workspace (i.e. $GIT_DIR, typically `angular/.git/config`): ``` [include] path = ../.ng-dev/gitconfig ``` I'm intentionally keeping the config inert for now until we prove that this is a good idea. Eventually we could roll this change out to all the contributors via an npm post-install script. PR Close #37951
Git provides a way to create a commit message template via the `.gitmessage` file. Introduce an Angular-specific .gitmessage template based on the original Commit Message Guidelines. https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines If this template workflow is proven in practice, we can move the commit message guidelines into the .gitmessage file to prevent duplication of the content. This change is a follow up on #37949 and is inspired by info found in the following blog post: https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template PR Close #37951
This doc is very old and rusty. I'm reformatting it to follow the one-setence-per-line rule. I also updated a few sections, since they were either poorly written or obsolete. PR Close #37951
Git provides a way to create a commit message template via the `.gitmessage` file. Introduce an Angular-specific .gitmessage template based on the original Commit Message Guidelines. https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines If this template workflow is proven in practice, we can move the commit message guidelines into the .gitmessage file to prevent duplication of the content. This change is a follow up on #37949 and is inspired by info found in the following blog post: https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template PR Close #37951
This doc is very old and rusty. I'm reformatting it to follow the one-setence-per-line rule. I also updated a few sections, since they were either poorly written or obsolete. PR Close #37951
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
…stent git config (angular#37951) This file is inert unless it's explicitly included into the local git config via: ``` git config --add include.path '../.ng-dev/gitconfig' ``` Calling that command will append the following into `.git/config` of the current git workspace (i.e. $GIT_DIR, typically `angular/.git/config`): ``` [include] path = ../.ng-dev/gitconfig ``` I'm intentionally keeping the config inert for now until we prove that this is a good idea. Eventually we could roll this change out to all the contributors via an npm post-install script. PR Close angular#37951
Git provides a way to create a commit message template via the `.gitmessage` file. Introduce an Angular-specific .gitmessage template based on the original Commit Message Guidelines. https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines If this template workflow is proven in practice, we can move the commit message guidelines into the .gitmessage file to prevent duplication of the content. This change is a follow up on angular#37949 and is inspired by info found in the following blog post: https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template PR Close angular#37951
This doc is very old and rusty. I'm reformatting it to follow the one-setence-per-line rule. I also updated a few sections, since they were either poorly written or obsolete. PR Close angular#37951
See individual commits for info.