Skip to content

Latest commit

 

History

History
167 lines (123 loc) · 2.81 KB

File metadata and controls

167 lines (123 loc) · 2.81 KB

Here are additional recommended documents for a professional open-source project:

  1. SECURITY.md (Vulnerability Reporting)
# Security Policy

## Reporting Vulnerabilities
Email: security@mimris.com
Response time: 72 hours
Bounty program: Coming 2024

## Supported Versions
| Version | Supported          |
| ------- | ------------------ |
| 2.1.x   | :white_check_mark: |
| < 2.0   | :x:                |
  1. docs/ARCHITECTURE.md (Technical Design)
# System Architecture

## Core Modules
1. **Diagram Engine**: GoJS-based rendering pipeline
2. **State Management**: Redux Toolkit with middleware
3. **Plugin System**: Webpack Module Federation
...

## Data Flow Diagram
[Insert Mermaid diagram]
  1. CHANGELOG.md (Release Notes)
# Changelog

## [2.1.0] - 2023-08-20
### Added
- Node grouping functionality
- Plugin version checker

### Fixed
- Memory leak in undo stack
...
  1. ROADMAP.md (Future Plans)
# Product Roadmap

## Q4 2023
- [ ] Real-time collaboration
- [ ] Version control integration

## 2024
- [ ] Mobile PWA version
- [ ] AI-assisted node creation
  1. AUTHORS.md (Credits)
# Project Authors

## Core Team
- Jane Doe (@janedoe) - Project Lead
- Alex Smith (@alexsmith) - Architect

## Contributors
- Thank you to our 42 contributors!
[![Contributors](https://contrib.rocks/image?repo=yourusername/GraphicModelingApp)]
  1. TESTING.md (QA Process)
# Testing Strategy

## Unit Tests
- 90% coverage required
- Jest + Testing Library

## E2E Testing
- Cypress workflows
- Visual regression testing
  1. STYLEGUIDE.md (Code Conventions)
# Style Guide

## TypeScript
- Functional components only
- Prefer `interface` over `type`

## Redux
- Use RTK Query for async
- Normalized state shape
  1. API_REFERENCE.md (Developer Docs)
# Plugin API Reference

```typescript
interface PluginConfig {
  name: string;
  init: (diagram: go.Diagram) => void;
}
  1. SUPPORT.md (User Help)
# Getting Help

## Community Resources
- Discord: [link]
- Stack Overflow tag: `graphicmodelingapp`

## Enterprise Support
Contact: enterprise@graphicmodelingapp.com
  1. GOVERNANCE.md (Project Management)
# Project Governance

## Decision Making
- RFC process for major changes
- Core team votes on proposals

## Maintainer Responsibilities
- Code review rotation
- Security monitoring
  1. .github/ISSUE_TEMPLATE (Standardized Reporting)
---
name: Bug Report
about: Report unexpected behavior
title: "[BUG] "
labels: bug
---

## Environment
- Version: 
- OS: 
- Browser: 

## Reproduction Steps
1. 
2. 
3. 

## Expected vs Actual

Would you like me to create any of these documents specifically tailored for your project? Let me know which ones would be most helpful.