Docs: Update README and CONTRIBUTING for open-source project (#1)

Changes:
- README.md:
  - Add CI/CD, License, and PRs Welcome badges
  - Add detailed Contributing section with branch protection notes
  - Add CI/CD Pipeline section explaining GitHub Actions
  - Add Community & Support section with links
  - Improve project description and formatting

- CONTRIBUTING.md:
  - Update workflow to reflect branch protection (no direct pushes)
  - Add detailed 11-step contribution process
  - Add conventional commit guidelines
  - Update project structure to show all files
  - Expand Code Review Process with automated checks
  - Add Code of Conduct section
  - Add enforcement policies and reporting guidelines
  - Update questions section with multiple contact methods

These changes reflect the project's transformation to a professional
open-source project with CI/CD, branch protection, and community guidelines.

Co-authored-by: Rafael Teodoro <rafael@example.com>

Author: rafaelctz

CONTRIBUTING.md

@@ -27,37 +27,81 @@ We welcome feature suggestions! Please create an issue with:
 
 ### Code Contributions
 
+**Important:** The `main` branch is protected. Direct pushes are not allowed. All changes must go through Pull Requests with review approval.
+
+#### Step-by-Step Process:
+
 1. **Fork the repository**
+   - Click "Fork" at the top of the repository page
+   - Clone your fork: `git clone https://github.com/YOUR_USERNAME/GWorkspace-toolbox.git`
 
-2. **Create a feature branch**
+2. **Set up development environment**
+   ```bash
+   # Option 1: Local development
+   cd backend && pip install -r requirements.txt
+   cd ../frontend && npm install
+
+   # Option 2: Docker development
+   docker-compose -f docker-compose.dev.yml up
+   ```
+
+3. **Create a feature branch**
    ```bash
    git checkout -b feature/your-feature-name
    ```
 
-3. **Make your changes**
+4. **Make your changes**
    - Follow the existing code style
    - Add comments for complex logic
    - Update documentation as needed
+   - Write meaningful commit messages
 
-4. **Test your changes**
+5. **Test your changes**
    - Test locally before submitting
    - Ensure both backend and frontend work correctly
    - Test in both development and Docker environments
+   - Verify CI/CD will pass (Docker builds)
 
-5. **Commit your changes**
+6. **Commit your changes**
    ```bash
+   git add .
    git commit -m "Add: Brief description of your changes"
    ```
 
-6. **Push to your fork**
+   Use conventional commit prefixes:
+   - `Add:` for new features
+   - `Fix:` for bug fixes
+   - `Update:` for improvements to existing features
+   - `Docs:` for documentation changes
+   - `Refactor:` for code restructuring
+
+7. **Push to your fork**
    ```bash
    git push origin feature/your-feature-name
    ```
 
-7. **Create a Pull Request**
-   - Provide a clear description of the changes
-   - Reference any related issues
-   - Include screenshots for UI changes
+8. **Create a Pull Request**
+   - Go to the [repository](https://github.com/rafaelctz/GWorkspace-toolbox)
+   - Click "Compare & pull request"
+   - Fill out the PR template with:
+     - Clear description of changes
+     - Reference to related issues (`Fixes #123`)
+     - Screenshots for UI changes
+     - Test results/evidence
+
+9. **Wait for CI/CD checks**
+   - GitHub Actions will automatically build Docker images
+   - Ensure all checks pass (green ✅)
+   - Fix any issues if checks fail (red ❌)
+
+10. **Code Review**
+    - A maintainer will review your PR
+    - Address any feedback or requested changes
+    - Once approved, your PR will be merged!
+
+11. **Celebrate!** 🎉
+    - Your contribution is now part of the project
+    - It will be automatically deployed via Watchtower
 
 ## Development Guidelines
 
@@ -93,18 +137,27 @@ When adding new text:
 ## Project Structure
 
 ```
-DEA-toolbox/
-├── backend/              # FastAPI backend
-│   ├── main.py          # Main application
-│   ├── services/        # Business logic
-│   └── requirements.txt # Python dependencies
-├── frontend/            # React frontend
+GWorkspace-toolbox/
+├── .github/
+│   └── workflows/
+│       └── docker-publish.yml   # CI/CD pipeline
+├── backend/                     # FastAPI backend
+│   ├── main.py                 # Main application
+│   ├── services/               # Business logic
+│   ├── requirements.txt        # Python dependencies
+│   └── Dockerfile              # Backend container
+├── frontend/                    # React frontend
 │   ├── src/
-│   │   ├── components/  # React components
-│   │   ├── locales/     # i18n translations
-│   │   └── App.jsx      # Main app component
-│   └── package.json     # Node dependencies
-└── docker-compose.yml   # Docker configuration
+│   │   ├── components/         # React components
+│   │   ├── locales/            # i18n translations (en, es, pt)
+│   │   └── App.jsx             # Main app component
+│   ├── package.json            # Node dependencies
+│   └── Dockerfile              # Frontend container
+├── docker-compose.yml           # Production (pre-built images + Watchtower)
+├── docker-compose.dev.yml       # Development (build from source)
+├── README.md                    # Main documentation
+├── CONTRIBUTING.md              # This file
+└── LICENSE                      # MIT License
 ```
 
 ## Adding New Tools
@@ -128,11 +181,44 @@ When adding a new tool to the toolbox:
 
 ## Code Review Process
 
-All submissions require review. We'll:
-- Review code quality and style
-- Test functionality
-- Check documentation
-- Provide constructive feedback
+All submissions require review and approval before merging. This is enforced by branch protection rules.
+
+### What We Review:
+
+- ✅ **Code Quality**: Clean, readable, well-structured code
+- ✅ **Style Compliance**: Follows project conventions (PEP 8, React best practices)
+- ✅ **Functionality**: Works as intended, no regressions
+- ✅ **Tests**: Changes are tested and don't break existing features
+- ✅ **Documentation**: README, comments, and docstrings updated
+- ✅ **Security**: No credential leaks, proper input validation
+- ✅ **CI/CD**: GitHub Actions checks pass (Docker builds)
+
+### Review Timeline:
+
+- Most PRs reviewed within **1-3 days**
+- Simple fixes: often same day
+- Large features: may take longer
+
+### Automated Checks:
+
+All PRs trigger automatic checks:
+1. **Docker Backend Build**: Ensures backend Dockerfile builds successfully
+2. **Docker Frontend Build**: Ensures frontend Dockerfile builds successfully
+
+If checks fail:
+- ❌ PR cannot be merged
+- Review the GitHub Actions logs
+- Fix issues and push updates
+- Checks will run again automatically
+
+### Getting Your PR Merged:
+
+1. All CI/CD checks must pass ✅
+2. At least 1 approval from a maintainer ✅
+3. All review comments addressed ✅
+4. No merge conflicts ✅
+
+Once approved, a maintainer will merge using **squash merge** to keep history clean.
 
 ## Future Tools Roadmap
 
@@ -144,9 +230,40 @@ Ideas for future tools (contributions welcome!):
 - **Group Membership Analyzer**: Analyze group hierarchies
 - **Multi-provider Support**: Azure AD, Okta, OneLogin, etc.
 
+## Code of Conduct
+
+### Our Standards
+
+We are committed to providing a welcoming and inclusive environment for everyone. We expect:
+
+- ✅ **Respectful communication**: Be kind and professional
+- ✅ **Constructive feedback**: Focus on code, not people
+- ✅ **Collaboration**: Work together to solve problems
+- ✅ **Patience**: Remember that everyone was a beginner once
+- ✅ **Inclusivity**: Welcome contributors of all skill levels
+
+### Unacceptable Behavior
+
+- ❌ Harassment, discrimination, or offensive comments
+- ❌ Personal attacks or trolling
+- ❌ Spam or off-topic discussions
+- ❌ Sharing others' private information
+
+### Enforcement
+
+Violations may result in:
+1. Warning
+2. Temporary ban from the project
+3. Permanent ban for serious or repeated violations
+
+Report issues to the project maintainer via GitHub issues or email.
+
 ## Questions?
 
-Feel free to create an issue for questions or discussions about contributing.
+Feel free to:
+- Create an [issue](https://github.com/rafaelctz/GWorkspace-toolbox/issues) for questions
+- Start a [discussion](https://github.com/rafaelctz/GWorkspace-toolbox/discussions)
+- Ask in your Pull Request
 
 ## License
 

README.md

@@ -1,6 +1,12 @@
 # GWorkspace Toolbox
 
-A comprehensive toolkit for Google Workspace administrators with tools for user management, group synchronization, and attribute injection.
+[![Docker Build](https://github.com/rafaelctz/GWorkspace-toolbox/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/rafaelctz/GWorkspace-toolbox/actions/workflows/docker-publish.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
+
+A comprehensive, open-source toolkit for Google Workspace administrators with tools for user management, group synchronization, and attribute injection.
+
+**🚀 Features automatic updates • 🌍 Multi-language support • 🐳 Docker-ready • 🔒 Branch-protected**
 
 ## Features
 
@@ -108,8 +114,48 @@ Once running, access the interactive API documentation at:
 
 ## Contributing
 
-This is an open-source project. Contributions are welcome!
+We welcome contributions from the community! 🎉
+
+### 🐛 Found a Bug?
+[Open an issue](https://github.com/rafaelctz/GWorkspace-toolbox/issues/new) with details about the problem.
+
+### 💡 Have an idea?
+[Submit a feature request](https://github.com/rafaelctz/GWorkspace-toolbox/issues/new) or start a discussion.
+
+### 🔨 Want to contribute code?
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Push to your branch (`git push origin feature/amazing-feature`)
+5. [Open a Pull Request](https://github.com/rafaelctz/GWorkspace-toolbox/compare)
+
+**Note:** The `main` branch is protected and requires:
+- ✅ Pull Request review and approval
+- ✅ CI/CD checks to pass (Docker builds)
+- ✅ No direct pushes allowed
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+## CI/CD Pipeline
+
+This project uses GitHub Actions for continuous integration:
+- ✅ Automatic Docker image builds on every push to `main`
+- ✅ Images published to GitHub Container Registry
+- ✅ Watchtower automatically updates running instances
+- ✅ Branch protection ensures code quality
+
+View builds: [GitHub Actions](https://github.com/rafaelctz/GWorkspace-toolbox/actions)
+
+## Community & Support
+
+- 📫 [Report Issues](https://github.com/rafaelctz/GWorkspace-toolbox/issues)
+- 💬 [Discussions](https://github.com/rafaelctz/GWorkspace-toolbox/discussions)
+- 📖 [Documentation](https://github.com/rafaelctz/GWorkspace-toolbox/wiki)
 
 ## License
 
-MIT License
+MIT License - see [LICENSE](LICENSE) for details
+
+---
+
+**Made with ❤️ for Google Workspace administrators**