Skip to content

Conversation

Copy link

Copilot AI commented Sep 24, 2025

Addresses the need for a comprehensive contributing guide by creating a detailed CONTRIBUTING.md file that covers all aspects of contributing to the Fractalic AI workflow system.

What This PR Adds

Comprehensive Development Setup

  • Multiple setup methods: core Python development, full stack with UI, and Docker-based development
  • Clear installation instructions for different contribution types
  • Validation commands to verify setup works correctly

Project Structure Documentation

  • Detailed breakdown of the codebase architecture (core/, tests/, docs/, publisher/, etc.)
  • Specific guidance on where different types of contributions should be made
  • Clear explanation of key directories and their purposes

Testing Framework Coverage

  • Documentation of Fractalic's unique testing approach using .md files as tests
  • Python unit testing with pytest
  • Integration and end-to-end testing procedures
  • Publisher/deployment system testing

Multiple Contribution Pathways

  • Core interpreter and operations development
  • LLM provider integrations
  • MCP (Model Context Protocol) tool development
  • Documentation and examples
  • Deployment and infrastructure improvements

Professional Development Practices

  • Code style guidelines using Black, flake8, and mypy
  • Commit message conventions and PR templates
  • Issue reporting guidelines with clear templates
  • Review process and community standards

Integration with Existing Standards

This guide properly integrates with the project's existing documentation ecosystem:

  • References the established documentation authoring guidelines (.github/instructions/docs.instructions.md)
  • Links to the existing Code of Conduct
  • Maintains consistency with project tone and markdown style
  • Uses the same structured approach as other project documentation

Validation

The guide has been validated against the actual project structure:

  • All CLI commands and installation methods have been tested
  • Directory structure matches the documented layout
  • Links to community resources (Discord, documentation) are accurate
  • Configuration files and scripts exist as described

This comprehensive guide provides clear pathways for contributors at all levels, from first-time contributors submitting documentation fixes to experienced developers adding new core features or deployment platforms.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@dimusdim dimusdim marked this pull request as ready for review September 24, 2025 17:01
@dimusdim dimusdim closed this Sep 24, 2025
Copilot AI changed the title [WIP] write contributing guide Add comprehensive contributing guide for Fractalic project Sep 24, 2025
Copilot AI requested a review from dimusdim September 24, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants