Shift-Core Documentation

Start Here

Start Here

Welcome to the ShiftCore Team Handbook.

This document explains how to use this repository and what each team member should read first.

Why This Handbook Exists

The goal of this handbook is to help us work like a real engineering team.

Before starting the graduation project, we need to make sure that every team member understands:

  • Git basics
  • GitHub workflow
  • Branch naming
  • Commit messages
  • Pull Requests
  • Code Review
  • Merge rules
  • Documentation standards
  • Jira workflow
  • Team communication

This handbook is our shared reference.

How to Use This Repository

This repository is not for the final graduation project code.

It is for team rules, workflows, standards, and learning references.

The final project will have its own repository later.

0. Start Here

Read this document first:

docs/00-start-here.md

1. Start with Git/GitHub

Read these files first:

docs/git/git-workflow.md
docs/git/branch-and-commit-rules.md
docs/git/pull-request-guide.md
docs/git/code-review-guide.md
docs/git/conflict-handling.md
docs/git/github-security.md

These files explain how we work with Git and GitHub.

2. Then Move to Jira

After we finish the Git/GitHub foundation, read:

docs/jira/jira-workflow.md
docs/jira/task-writing-guide.md
docs/jira/acceptance-criteria.md
docs/jira/sprint-process.md

These files explain how we manage tasks and sprints.

3. Then Read Documentation Standards

Read:

docs/documentation/documentation-standards.md
docs/documentation/readme-template.md
docs/documentation/decision-log-template.md

These files explain how we write clear and useful documentation.

Current Team Focus

Our current focus is:

Git & GitHub Foundation

This means every team member should be able to:

  • Create a branch
  • Make a clear commit
  • Push changes
  • Open a Pull Request
  • Request a review
  • Review someone else's Pull Request
  • Resolve comments
  • Understand merge rules
  • Avoid pushing directly to main

What Every Team Member Must Practice

Each team member should practice the following:

1. 2. 3.

Team Workflow

Our basic workflow is:

Task
→ Branch
→ Commit
→ Push
→ Pull Request
→ Review
→ Fix comments
→ Approval
→ Merge

This workflow should be followed even for small changes.

Important Rule

Do not push directly to main.

Even if the change is small, create a branch and open a Pull Request.

The goal is to practice the same workflow we will use in the real project.

Next Step

After reading this file, start with:

docs/git/git-workflow.md