diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bab9bae..493c71a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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 diff --git a/BRANCHING.md b/BRANCHING.md index 33fdf6d..6f97938 100644 --- a/BRANCHING.md +++ b/BRANCHING.md @@ -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) @@ -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 @@ -32,7 +29,7 @@ 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/*`) @@ -40,8 +37,8 @@ git checkout -b feature/add-slack-detection ```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 @@ -50,7 +47,7 @@ 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/*`) @@ -58,8 +55,8 @@ git checkout -b fix/false-positive-arns ```bash # Create -git checkout develop -git pull upstream develop +git checkout main +git pull upstream main git checkout -b docs/update-readme # Example names @@ -68,7 +65,7 @@ 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/*`) @@ -76,8 +73,8 @@ git checkout -b docs/update-readme ```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 @@ -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 . @@ -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 . @@ -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 . @@ -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 . diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 772cc04..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,30 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We are committed to providing a welcoming and inspiring community. Participation in our project should be harassment-free for everyone, regardless of age, body size, disability, ethnicity, gender identity, experience level, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity. - -## Our Standards - -### Positive Behavior -- Using welcoming and inclusive language -- Being respectful of differing opinions -- Giving and accepting constructive criticism -- Focusing on what's best for the community -- Showing empathy towards community members - -### Unacceptable Behavior -- Sexualized language or imagery -- Trolling, insulting or derogatory comments -- Personal or political attacks -- Public or private harassment -- Publishing private information without permission -- Other conduct inappropriate in a professional setting - -## Enforcement - -Instances of unacceptable behavior should be reported to the project team. All complaints will be reviewed and investigated. We are committed to maintaining the safety and respect of all community members. - ---- - -**Thank you for helping us maintain a welcoming community!** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 174a953..f7df8d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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) ``` --- @@ -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! diff --git a/PULL_REQUEST_PROCESS.md b/PULL_REQUEST_PROCESS.md index b43ae44..af87c7c 100644 --- a/PULL_REQUEST_PROCESS.md +++ b/PULL_REQUEST_PROCESS.md @@ -3,7 +3,7 @@ ## 📊 PR Workflow ``` -1. Create Branch from develop +1. Create Branch from main ↓ 2. Make Changes + Add Tests ↓ @@ -32,7 +32,7 @@ ↓ 10. Approval ✅ ↓ -11. Merge to develop +11. Merge to main ↓ 12. Delete branch ``` @@ -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