Skip to content

Commit 0b65530

Browse files
authored
chore: add issue form for submitting blocks (#974)
* feat: add issue form for submitting blocks Adds `share_block.yml` to `ISSUE_TEMPLATE` to streamline the block submission process * fix: remove block code section
1 parent 4a3b1cd commit 0b65530

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "Submit a Custom Block"
2+
description: "Use this template to submit a new custom block (schema) for BlockNote."
3+
title: "<Your Block Name>"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Submit a Custom Block (Schema)
9+
10+
Thank you for contributing to BlockNote! Please fill out the following sections to submit your custom block. Make sure to provide as much detail as possible to help us understand and showcase your block effectively.
11+
12+
- type: input
13+
id: block_name
14+
attributes:
15+
label: "Block Name"
16+
description: "Enter the name of your custom block."
17+
placeholder: "e.g., Alert Block"
18+
19+
- type: textarea
20+
id: block_description
21+
attributes:
22+
label: "Block Description"
23+
description: "Provide a detailed description of your custom block. Explain its purpose and how it works."
24+
placeholder: "This block is used to display alert messages with different severity levels."
25+
26+
- type: textarea
27+
id: block_dependencies
28+
attributes:
29+
label: "Dependencies"
30+
description: "Provide a full list of all the dependencies needed to make your custom block work."
31+
placeholder: "`npm_package_1`, `npm_package_2`, ...etc "
32+
33+
- type: input
34+
id: live_example
35+
attributes:
36+
label: "Live Example"
37+
description: "Please provide a valid URL to a codepen, stackblitz, codeSandbox, or simply a github repo"
38+
placeholder: "live example URL here"
39+
40+
- type: textarea
41+
id: usage_instructions
42+
attributes:
43+
label: "Usage Instructions"
44+
description: "Explain how to use your custom block in a BlockNote application. Include any necessary setup steps."
45+
placeholder: |
46+
```markdown
47+
1. Import your custom block.
48+
2. Add it to the BlockNote editor configuration.
49+
3. Use it within the BlockNote editor.
50+
```
51+
52+
- type: textarea
53+
id: additional_notes
54+
attributes:
55+
label: "Additional Notes"
56+
description: "Include any additional information or notes about your custom block."
57+
placeholder: "Any additional context or information."

0 commit comments

Comments
 (0)