Table of Contents
Configuration
It is recommended that all developers run the following Git configuration commands:
git config --global --add branch.autosetupmerge true git config --global --add branch.autosetuprebase always git config --global --add push.default simple
Git has an issue with files containing unicode characters in their file name on any system using HFS+ filesystem. If you use a Mac and experience an untracked file immediately upon cloning the edx-platform repo, try running the following configuration command:
git config --global core.precomposeunicode false
Squashing Commits
- Squash commits (as appropriate) before requesting a review.
- Do not squash commits once a review has started, to aid reviewers.
- Squash commits after the review, before merging a PR.
Commit Messages
- We follow the 50/72 rule for writing commit messages
- The first line of a commit message should be a title in 50 characters or less.
- Further comments should be paragraphs wrapped to 72 characters
- Include the JIRA ticket number on its own line to be picked up by scripts
- Example commit message:
https://github.com/edx/edx-platform/commit/978e9fe656bb249237ba1ceea0ebec1aa0b06fa7
Fix inline discussions to use cached static assets In production environments, the DiscussionXBlock was generating CSS and JS asset URLs that pointed to the unminified versions of those bundled assets. Due to our nginx rules, this would cause the assets to be served without the long expiration times, forcing the user's browser to constantly refetch these assets while browsing a course. [PERF-431]
- Why is this important?
- Many tools including GitHub assume the presence of a short title.
- Release scripts and others can extract the ticket numbers to include in a list of commits
- JIRA will link a ticket to any commits that include that ticket's number
- e.g. LEARNER-1696 - Getting issue details... STATUS
- Here are a few blog posts that explain the rationale behind these rules: