Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.73 KB

Contributing Guide

Thank you for your interest in contributing to the AI Workflow Delivery Framework. This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your contribution
  4. Make your changes
  5. Test your changes
  6. Submit a pull request

Types of Contributions

Documentation Improvements

  • Fix typos or clarify existing documentation
  • Add examples or use cases
  • Translate documentation

Template Additions

  • Add new workflow templates
  • Improve existing templates
  • Add industry-specific variations

Bug Fixes

  • Report bugs via GitHub Issues
  • Submit fixes via pull requests

Feature Requests

  • Open an issue to discuss new features
  • Provide context and use cases

Pull Request Process

  1. Create a descriptive title - Summarize what your PR does
  2. Write a clear description - Explain what changes you made and why
  3. Reference related issues - Link to any related GitHub issues
  4. Keep changes focused - One PR should address one concern
  5. Update documentation - If your changes require documentation updates

Code Style

  • Use clear, descriptive names
  • Keep files organized in appropriate directories
  • Follow existing patterns in the codebase
  • Add comments where necessary for clarity

Commit Messages

Use clear commit messages that describe what changed:

Add: new client onboarding template
Fix: typo in deployment checklist
Update: improve error handling documentation

Questions?

If you have questions about contributing:

License

By contributing, you agree that your contributions will be licensed under the MIT License.