devset

View Documentation on GitHub Pages

Project Overview

This repository serves as a comprehensive collection of development tools, templates, and best practices for initializing and maintaining code repositories. It provides a standardized foundation for projects to ensure consistency, quality, and maintainability.

Purpose

The main goal of this repository is to provide developers with:

• A complete set of documentation templates and standards
• Automated workflows for common development tasks
• Standardized project structures and configurations
• Cline memory bank and rule systems for AI-assisted development
• Dev container configurations for consistent development environments
• Post-fork setup automation for maintaining proper attribution

Use Pattern

This repository is designed to be used as a template/reference:

1. Developers start with their existing git repository
2. They download/clone the files from this repository into their project
3. The files are then maintained separately in each individual project
4. Each project can customize and extend the templates as needed

Key Components

Memory Bank System

• memory-bank/ - Core documentation files for project context
• clinerules-bank/ - Standard rules and guidelines
• clines-memory-bank-rule.md - Documentation of the memory bank system

Workflow Collection

• workflows/ - Automation workflows for various development tasks
• Includes initialization, maintenance, and operational workflows
• Each workflow is documented with parameters and steps

Dev Container Configuration

• .devcontainer/ - VS Code dev container setup
• Pre-configured with common development tools and extensions
• Ensures consistent development environments

Technical Documentation

• docs/technical_design_doc.md - Template for technical design documents
• Standardized format for project documentation

How to Use

1. Clone or fork this repository
2. Copy the desired files into your existing project
3. Customize the templates to match your specific project needs
4. Maintain the files separately in your project repository
5. Use the workflows for automated task execution

Benefits

• Consistency: Standardized templates across projects
• Efficiency: Pre-built workflows reduce setup time
• Quality: Established rules and guidelines improve code quality
• Maintainability: Clear documentation and structure
• Collaboration: Shared standards facilitate team development

Citing This Project

If you use this repository in your work, please consider citing it to give credit to the original authors and help others discover this resource. You can cite it as:

For academic or research use:

[Author Name], [Project Name], [Repository URL], [Year]. Available online at [URL]

For software projects:

• Include a reference in your project's documentation
• Add a note in your README.md mentioning this repository
• Consider adding a badge to your project's README (if applicable)

Example citation format:

devset - A collection of development tools and templates
https://github.com/toxicoder/devset

Support My Projects

If you find this repository helpful and would like to support its development, consider making a donation:

GitHub Sponsors

Buy Me a Coffee

PayPal

Ko-fi

Coinbase

Your support helps maintain and improve this collection of development tools and templates. Thank you for contributing to open source!

This project is licensed under MIT - see the LICENSE file for details.