Team collaboration guidelines

Team Collaboration Guidelines

Team collaboration is a crucial aspect of software development, and well-defined collaboration standards can significantly improve development efficiency and code quality. Git, as a distributed version control system, provides powerful support for team collaboration but also requires clear guidelines to avoid chaos.

Git Branch Management Strategy

A reasonable branch management strategy is the foundation of team collaboration. We recommend adopting Git Flow or a similar branching model:

// Example: Creating a feature branch
git checkout -b feature/user-authentication

Main branches typically include:

• main/master: Production environment code
• develop: Integration development branch
• release/*: Pre-release branches
• feature/*: Feature development branches
• hotfix/*: Emergency fix branches

Each feature development should start by creating an independent branch from the develop branch, named according to the convention feature/feature-name. For example:

git checkout develop
git pull origin develop
git checkout -b feature/payment-integration

Commit Message Standards

Clear commit messages help team members understand changes. We recommend using Conventional Commits:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Common types include:

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Code formatting
• refactor: Code refactoring
• test: Test-related changes
• chore: Build process or auxiliary tool changes

Example:

feat(authentication): add OAuth2 login support

- Implement Google OAuth2 provider
- Add related UI components
- Update documentation

Closes #123

Code Review Process

Code review is a critical step in ensuring code quality and should follow these guidelines:

1. Create a merge request (MR)/pull request (PR) after development is complete
2. Require review by at least 1-2 team members
3. All CI tests must pass
4. Resolve all review comments before merging

Example review comment:

// Suggestion: Array.prototype.map could simplify this
const userIds = [];
for (let i = 0; i < users.length; i++) {
  userIds.push(users[i].id);
}
// Could be changed to:
const userIds = users.map(user => user.id);

Conflict Resolution Strategy

Conflicts may occur when multiple people modify the same file. The resolution process should be:

1. Regularly pull the latest changes from the main branch
2. When conflicts occur, prioritize communication with the original author
3. Use tools like git mergetool to assist in resolution
4. Test the resolved code

# Example conflict resolution process
git fetch origin
git rebase origin/develop
# After handling conflict files
git add .
git rebase --continue

Version Tagging Standards

Use Semantic Versioning (SemVer) when tagging releases:

v<major>.<minor>.<patch>

Example:

git tag -a v1.2.0 -m "Release version 1.2.0 with new dashboard"
git push origin v1.2.0

Ignore File Configuration

Ensure .gitignore includes all files that should not be tracked:

# Frontend project example
node_modules/
dist/
*.log
.DS_Store
.env
.idea/
*.local

Hook Script Usage

Git hooks can automate standard checks, such as in pre-commit:

#!/bin/sh
# Run lint check
npm run lint
if [ $? -ne 0 ]; then
  echo "Lint check failed, please fix before committing"
  exit 1
fi

Large File Handling

Avoid including large binary files in Git. Use Git LFS or external storage instead:

# After installing Git LFS
git lfs track "*.psd"
git lfs track "*.zip"

Workspace Cleanup

Regularly clean up unnecessary local and remote branches:

# Delete merged local branches
git branch --merged | egrep -v "(^\*|main|develop)" | xargs git branch -d

# Delete merged remote branches
git fetch --prune

Staging Changes Tips

Use stash effectively to save temporary changes:

# Save current work
git stash push -m "WIP: authentication middleware"

# Restore most recent stash
git stash pop

Bisect Debugging

Use git bisect to quickly locate problematic commits:

git bisect start
git bisect bad HEAD
git bisect good v1.0.0
# Mark current version as good or bad after testing
git bisect reset

Submodule Management

When projects contain submodules, ensure unified team operations:

# Clone project with submodules
git clone --recurse-submodules <repository>

# Update all submodules
git submodule update --init --recursive

Backup Strategy

In addition to remote repositories, establish additional backup mechanisms:

# Push to multiple remote repositories
git remote set-url --add origin git@backup-server:project.git
git push origin --all

Sensitive Data Handling

Never commit sensitive information to version control. Use environment variables or configuration templates:

// config.template.js
module.exports = {
  apiKey: process.env.API_KEY,
  dbUrl: process.env.DB_URL
};

// .gitignore
config.js