Tweask

Author: JonZeolla

CONTRIBUTING.md

@@ -1,8 +1,9 @@
 # Contributing
 
-To contribute to this project, please fork the repository and open a pull request with your changes.
+To contribute to this project, please consider starting by [opening an issue](https://github.com/Zenable-io/ai-native-python/issues/new) to discuss the feature
+and its design, and reviewing our Contributors Code of Conduct [here](./.github/CODE_OF_CONDUCT.md).
 
-Also, see our Contributors Code of Conduct [here](./.github/CODE_OF_CONDUCT.md).
+Once you are ready to submit your contribution, please fork the repository and open a pull request with your changes.
 
 ## Updating the dependencies
 

docs/ci-cd.md

@@ -9,9 +9,8 @@ The AI-Native Python template includes GitHub Actions workflows for automated te
 Runs on every push and pull request:
 
 1. **Linting** - Python (Ruff), YAML/JSON, shell scripts, GitHub Actions
-2. **Testing** - Unit and integration tests with >80% coverage requirement
+2. **Testing** - Unit and integration tests with >80% coverage requirement, as well as docker builds on each supported platform
 3. **Security** - Vulnerability scanning (Grype), SBOM generation (Syft), secret detection
-4. **Docker** - Optional multi-platform builds with security scanning
 
 ### Release Pipeline (`.github/workflows/release.yml`)
 
@@ -21,30 +20,25 @@ Automates semantic versioning and publishing:
 2. Updates version in `pyproject.toml`
 3. Generates changelog
 4. Creates GitHub release
-5. Pushes Docker images (if enabled)
+5. Pushes Docker images to Docker Hub (if enabled)
 
 ### PR Validation (`.github/workflows/pr.yml`)
 
 Ensures pull request quality:
+
 - Validates PR title follows conventional commit format
 - Checks all commit messages
-- Enforces branch protection rules
+- Look for deprecations or warnings and adds them to the finalizer
 
 ## Configuration
 
 For GitHub Actions configuration and required secrets, see the [Configuration Guide](configuration.md#post-generation-configuration).
 
-For Docker Hub setup specifically, if enabled during project generation, you'll need to set:
-- `DOCKERHUB_USERNAME`
-- `DOCKERHUB_PAT`
-
 ### Dependency Updates
 
 The generated project includes multiple dependency update mechanisms. See the [Configuration Guide](configuration.md#post-generation-configuration) for details
 on customizing these tools.
 
 ## Customization
 
-### Custom Workflows
-
 Add new workflows in `.github/workflows/` for specific needs like deployment or scheduled tasks.

docs/configuration.md

@@ -69,14 +69,11 @@ vars:
 
 For detailed information about pre-commit hooks configuration and available hooks, see the [Hooks Guide](hooks.md#pre-commit-hooks).
 
-### GitHub Actions Configuration
-
-For detailed information about CI/CD workflows and customization options, see the [CI/CD Guide](ci-cd.md).
-
-#### Required Secrets
+#### Docker Hub Secrets
 
 If you enabled Docker Hub publishing:
+
 - `DOCKERHUB_USERNAME`
 - `DOCKERHUB_PAT`
 
-These will be printed as a reminder after project generation.
+A reminder to set this is also printed after project generation if you answered "yes" to the docker hub question.