Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pytest tests/ -v
- [ ] All new and existing tests pass
- [ ] I have updated documentation (if needed)
- [ ] My changes do not introduce breaking changes
- [ ] PR targets `develop` branch (not `main`)
- [ ] PR targets `main` branch

## Additional Context
<!-- Add any other context about the PR here -->
45 changes: 21 additions & 24 deletions BRANCHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,7 @@
## 🌳 Branch Structure

```
main (production, releases only)
↑ (merge via release PR)
β”‚
develop (staging, next release)
main (primary branch, all changes via PRs)
↑ (merge via feature/fix/docs/chore PRs)
β”‚
β”œβ”€ feature/* (new features)
Expand All @@ -22,8 +19,8 @@ develop (staging, next release)

```bash
# Create
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b feature/add-slack-detection

# Example names
Expand All @@ -32,16 +29,16 @@ git checkout -b feature/add-slack-detection
βœ… feature/add-azure-version-check

# Merge
# Create PR: develop <- feature/add-slack-detection
# Create PR: main <- feature/add-slack-detection
```

### πŸ› Fix Branches (`fix/*`)
**Purpose**: Bug fixes

```bash
# Create
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b fix/false-positive-arns

# Example names
Expand All @@ -50,16 +47,16 @@ git checkout -b fix/false-positive-arns
βœ… fix/confidence-calculation

# Merge
# Create PR: develop <- fix/false-positive-arns
# Create PR: main <- fix/false-positive-arns
```

### πŸ“š Documentation Branches (`docs/*`)
**Purpose**: Documentation updates

```bash
# Create
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b docs/update-readme

# Example names
Expand All @@ -68,16 +65,16 @@ git checkout -b docs/update-readme
βœ… docs/installation-guide

# Merge
# Create PR: develop <- docs/update-readme
# Create PR: main <- docs/update-readme
```

### πŸ”§ Chore Branches (`chore/*`)
**Purpose**: CI/CD, dependencies, configuration

```bash
# Create
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b chore/update-github-actions

# Example names
Expand All @@ -86,15 +83,15 @@ git checkout -b chore/update-github-actions
βœ… chore/add-security-scanning

# Merge
# Create PR: develop <- chore/update-github-actions
# Create PR: main <- chore/update-github-actions
```

## πŸ”„ Workflow Summary

### Create Feature
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b feature/your-feature
# Make changes
git add .
Expand All @@ -105,8 +102,8 @@ git push origin feature/your-feature

### Fix a Bug
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b fix/bug-name
# Make changes + tests
git add .
Expand All @@ -117,8 +114,8 @@ git push origin fix/bug-name

### Update Docs
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b docs/update-name
# Make changes
git add .
Expand All @@ -129,8 +126,8 @@ git push origin docs/update-name

### Update CI/Config
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b chore/update-name
# Make changes
git add .
Expand Down
30 changes: 0 additions & 30 deletions CODE_OF_CONDUCT.md

This file was deleted.

35 changes: 14 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Thank you for your interest in contributing to ShieldCommit! This document provides guidelines and instructions for contributing.

## πŸ“‹ Table of Contents
- [Code of Conduct](#code-of-conduct)
- [Getting Started](#getting-started)
- [Development Setup](#development-setup)
- [Branching Strategy](#branching-strategy)
Expand All @@ -15,12 +14,6 @@ Thank you for your interest in contributing to ShieldCommit! This document provi

---

## πŸ“œ Code of Conduct

We are committed to providing a welcoming and inspiring community. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

---

## πŸš€ Getting Started

### Prerequisites
Expand Down Expand Up @@ -67,8 +60,8 @@ We use **four types of branches**:

### 1. **feature/** - New Features
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b feature/add-slack-detection

# Make changes, commit, push, create PR
Expand All @@ -77,8 +70,8 @@ git push origin feature/add-slack-detection

### 2. **fix/** - Bug Fixes
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b fix/false-positive-arns

# Make changes, commit, push, create PR
Expand All @@ -87,8 +80,8 @@ git push origin fix/false-positive-arns

### 3. **docs/** - Documentation
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b docs/update-readme

# Make changes, commit, push, create PR
Expand All @@ -97,8 +90,8 @@ git push origin docs/update-readme

### 4. **chore/** - CI/CD & Config
```bash
git checkout develop
git pull upstream develop
git checkout main
git pull upstream main
git checkout -b chore/update-dependencies

# Make changes, commit, push, create PR
Expand All @@ -121,9 +114,9 @@ git push origin chore/update-dependencies
## πŸ“ Making Changes

```bash
# 1. Create branch from develop
git checkout develop
git pull upstream develop
# 1. Create branch from main
git checkout main
git pull upstream main
git checkout -b feature/your-feature

# 2. Make changes
Expand All @@ -141,7 +134,7 @@ git commit -m "feat: add new detection method"
# 5. Push
git push origin feature/your-feature

# 6. Create PR on GitHub
# 6. Create PR on GitHub (target main branch)
```

---
Expand Down Expand Up @@ -186,13 +179,13 @@ def test_my_feature(self):
- [ ] All tests passing (92/92)
- [ ] Coverage > 80%
- [ ] Documentation updated
- [ ] PR targets `develop` branch (not `main`)
- [ ] PR targets `main` branch
- [ ] Commit messages follow convention

### Create PR
1. Push to your fork: `git push origin feature/your-feature`
2. Go to GitHub and click "New Pull Request"
3. Set Base: `develop`, Compare: `feature/your-feature`
3. Set Base: `main`, Compare: `feature/your-feature`
4. Fill PR template (auto-fills)
5. Submit!

Expand Down
6 changes: 3 additions & 3 deletions PULL_REQUEST_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## πŸ“Š PR Workflow

```
1. Create Branch from develop
1. Create Branch from main
↓
2. Make Changes + Add Tests
↓
Expand Down Expand Up @@ -32,7 +32,7 @@
↓
10. Approval βœ…
↓
11. Merge to develop
11. Merge to main
↓
12. Delete branch
```
Expand Down Expand Up @@ -65,7 +65,7 @@ Closes #123
- [x] Self-review completed
- [x] Tests updated
- [x] Docs updated
- [x] PR targets develop (not main)
- [x] PR targets main
```

## βœ… PR Checklist
Expand Down