-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Git Policies
Scott Erickson edited this page Apr 28, 2016
·
6 revisions
- Rebase and squash commits. Once you've handled code review feedback on a pull request or branch, squash commits down to a minimum number of meaningful commits. Merge feature branches into master. Read this article for pros and cons of merge or rebase policies.
- Follow good Git commit message practices. These are listed below. Source.
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Set up your text editor beforehand. This process involves git opening up a text editor, and if you're not familiar with emacs or vim you might have trouble. If you're on Mac, you can run in the terminal git config --global core.editor open
. This will tell git to open up TextEdit by default during interactive rebases and any other time git needs you to edit a file for input. open
may be substituted with atom
, subl
, vim
, etc depending on your editor of choice, if you have the corresponding command set up.
CodeCombat | Home | Blog | Forum | Teachers | Legal | Contribute
- Home
- Archmage Home
- Artisan Home
- Diplomat Home
- Archmage General
- Mission statement
- Coco Models
- Coding Guidelines
- Cookbook
- File system
- JSON Schema
- Technical overview
- Testing
- Third party software and services
- Artisan General
- Building A Level
- Coding Guidelines for Artisans
- Editing Thang Components
- Important Artisan Concepts
- Keyboard Shortcuts
- Debugging
- Artisan How-To Index
- Diplomat General
- i18n
- i18n Glossary nb
- i18n Glossary ru
- i18n Glossary es-419
- Dev Setup
- Dev Setup: Linux
- Dev Setup: Windows
- Dev Setup: Mac
- Dev Setup: Vagrant
- Dev Setup: Issues
- Game Engine
- Component
- Multiplayer
- Surface
- System
- Thang
- Thang Component System
- Tome
- World
- Artisan Tabs
- Components And Systems
- Scripts
- Settings
- Thangs
- Other
- Aether
- Client models
- Developer organization
- Educational Standards
- Events, subscriptions, shortcuts
- Chat Room
- Chat Room Rules
- Permissions
- Project Ideas List
- Treema
- Versioning
- Views