Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior in Chartifact
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out this form as completely as possible.

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
placeholder: What went wrong?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Detailed steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: Describe what you expected to happen
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: Describe what actually happened
validations:
required: true

- type: textarea
id: document
attributes:
label: Sample Document (if applicable)
description: If the bug relates to a specific document, please provide a minimal example (JSON or Markdown)
placeholder: Paste your .idoc.json or .idoc.md content here
render: json

- type: textarea
id: environment
attributes:
label: Environment
description: Please provide information about your environment
value: |
- OS: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
- Browser: [e.g., Chrome 120, Firefox 121, Safari 17]
- Node.js version: [e.g., 20.10.0]
- Chartifact version: [e.g., 1.0.0]
- VS Code version (if applicable): [e.g., 1.85.0]
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots or Screen Recording
description: If applicable, add screenshots or a screen recording to help explain the problem
placeholder: Drag and drop images or paste links here

- type: textarea
id: logs
attributes:
label: Console Logs or Error Messages
description: Please include any relevant console logs or error messages
placeholder: Paste console output here
render: shell

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here
placeholder: Any additional information that might be helpful

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: Please verify the following before submitting
options:
- label: I have searched for existing issues to avoid duplicates
required: true
- label: I have provided all the required information above
required: true
- label: I can reproduce this issue consistently
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: 💬 Discussions
url: https://github.com/microsoft/chartifact/discussions
about: Ask questions, share ideas, and engage with the community
- name: 📖 Documentation
url: https://microsoft.github.io/chartifact/
about: Browse the official Chartifact documentation and examples
- name: 🔒 Security Vulnerability
url: https://github.com/microsoft/chartifact/security/advisories/new
about: Report security vulnerabilities privately (do not use public issues)
109 changes: 109 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: ✨ Feature Request
description: Suggest a new feature or enhancement for Chartifact
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.

- type: textarea
id: problem
attributes:
label: Problem Statement
description: Is your feature request related to a problem? Please describe the problem you're trying to solve.
placeholder: I'm always frustrated when...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see
placeholder: A clear and concise description of what you want to happen
validations:
required: true

- type: dropdown
id: component
attributes:
label: Component Area
description: Which component or area of Chartifact does this relate to?
options:
- Document Schema
- Runtime/Sandbox
- VS Code Extension
- Web Viewer/Editor
- Text/Markdown
- Charts (Vega/Vega-Lite)
- Tables (Tabulator)
- Inputs (Forms)
- Diagrams (Mermaid)
- Images
- Presets
- Data Sources/REST
- CSS/Styling
- Documentation
- Examples
- Build/Tooling
- Other
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Describe any alternative solutions or features you've considered
placeholder: What other approaches have you thought about?

- type: textarea
id: examples
attributes:
label: Examples or Use Cases
description: Provide examples of how this feature would be used
placeholder: |
Example 1: ...
Example 2: ...

- type: textarea
id: mockup
attributes:
label: Mockups or Design Ideas
description: If applicable, add mockups, wireframes, or code examples
placeholder: Drag and drop images or paste code snippets here

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Nice to have
- Would improve my workflow
- Important for my use case
- Blocking my use of Chartifact
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context, screenshots, or references about the feature request
placeholder: Links to similar features in other tools, research, etc.

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: Please verify the following before submitting
options:
- label: I have searched for existing feature requests to avoid duplicates
required: true
- label: I have provided a clear description of the problem and solution
required: true
- label: This feature aligns with Chartifact's goals as a declarative, interactive document format
required: false
79 changes: 79 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
## Description

<!-- Provide a clear and concise description of your changes -->

## Related Issues

<!-- Link to related issues using "Fixes #123" or "Relates to #123" -->

Fixes #

## Type of Change

<!-- Mark the relevant option with an "x" -->

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📝 Documentation update
- [ ] ♻️ Code refactoring (no functional changes)
- [ ] 🎨 Style/formatting changes
- [ ] 🧪 Test additions or updates
- [ ] 🔧 Build/tooling changes

## Changes Made

<!-- List the specific changes you made -->

-
-
-

## Testing

<!-- Describe the testing you've done -->

- [ ] I have tested these changes locally
- [ ] All existing tests pass
- [ ] I have added new tests (if applicable)
- [ ] I have manually verified the changes work as expected

### Test Details

<!-- Describe how you tested your changes -->

## Screenshots/Recordings

<!-- If applicable, add screenshots or screen recordings to demonstrate the changes -->

## Documentation

- [ ] I have updated the documentation (if applicable)
- [ ] I have updated examples (if applicable)
- [ ] Code comments are clear and helpful

## Checklist

<!-- Review and check off all applicable items -->

- [ ] My code follows the project's coding guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings or errors
- [ ] I have checked for security issues in my changes
- [ ] I have not committed secrets, credentials, or sensitive data
- [ ] I have kept changes minimal and focused on the issue being addressed
- [ ] I have updated CONTRIBUTING.md if I added new development workflows

## Additional Context

<!-- Add any other context about the pull request here -->

## For Maintainers

<!-- Maintainers will fill this out during review -->

- [ ] Code review completed
- [ ] All CI checks passing
- [ ] Documentation reviewed
- [ ] Ready to merge
Loading