Skip to content

docs: align git workflow and pr rules with engineering handbook - #1

Merged
0PeterAdel merged 1 commit into
mainfrom
docs/align-handbook-rules
Oct 17, 2026
Merged

0PeterAdel merged 1 commit into
mainfrom
docs/align-handbook-rules

Conversation

@0PeterAdel

Copy link
Copy Markdown
Owner

What changed?

Aligned the project's contribution guidelines, PR template, and Git workflow documentation with the ShiftCore Engineering Handbook standards.

Why?

To establish a disciplined, readable, and professional Git history where:

  • No direct work or commits occur on main.
  • All tasks are developed on dedicated branches (type/short-task-name).
  • Commits follow Conventional Commits (type(scope): message).
  • Every change is reviewed and merged via a structured Pull Request.

How to review?

  1. Inspect .github/PULL_REQUEST_TEMPLATE.md to verify it follows the required PR sections (What changed, Why, How to review, Notes).
  2. Inspect CONTRIBUTING.md to confirm the branch types, commit scopes, and workflow instructions match the team handbook.

Notes

Prepares the repository for upcoming releases and community contributions.

@0PeterAdel
0PeterAdel merged commit 12a5032 into main Oct 17, 2026
3 checks passed
@0PeterAdel
0PeterAdel deleted the docs/align-handbook-rules branch October 17, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant