Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it useful to have a 'Git' portion in the style guide? #2

Closed
iteles opened this issue Aug 9, 2015 · 7 comments
Closed

Is it useful to have a 'Git' portion in the style guide? #2

iteles opened this issue Aug 9, 2015 · 7 comments

Comments

@iteles
Copy link
Member

iteles commented Aug 9, 2015

Describing things like:

  • Adding issues numbers to every commit to ensure there's always traceability
  • Writing a good issue
  • Writing a descriptive pull request that speeds up review time and reduces the amount of back and forth between the requestee and the assigned reviewer

Would this be useful in the style guide? Does it belong somewhere else?

I'm loathe to create too many repos of this kind of 'guide' stuff and would rather keep them to a minimum, but we do have to capture this somewhere!

@nelsonic
Copy link
Member

its essential.

@rjmk
Copy link

rjmk commented Aug 10, 2015

Also, repo naming? I tend not to keep a history so long repo names can be a bit of a faff for me, but I see the appeal of descriptive name as well. Some guidance would be good.

@iteles
Copy link
Member Author

iteles commented Aug 10, 2015

@rjmk 👍

@nelsonic
Copy link
Member

I'm a fan of _descriptive_ (says-what-it-does) repo names for a couple of reasons namely human find-ability and SEO. We have a few projects with single word names: time, tudo, esta and arana which are deliberately simple for eventual "branding". But the "naming convention" we have used is not explicit, we have simply followed the "is-the-name-available-on-npm" approach where the project will be a module (on NPM) and "explains-what-it-does" for everything else.

@iteles
Copy link
Member Author

iteles commented Aug 11, 2015

Adds images for style guide.

paired-commit-message

commit-message-referenced-from-issue

emojis-in-commit-messages

@iteles
Copy link
Member Author

iteles commented Aug 13, 2015

add-comment-inline-in-pr

add-comment-inline-in-pr-comment-box

@iteles
Copy link
Member Author

iteles commented Aug 15, 2015

history-tab-on-git-documents

blame-tab-on-git-documents

iteles added a commit that referenced this issue Aug 15, 2015
iteles added a commit that referenced this issue Aug 15, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants