Skip to content

Commit 7f529b3

Browse files
fzn0xephysWikiRik
authored
meta: add PR and issues templates for Sequelize website (#349)
* metA: add PR and issues templates for Sequelize website * Create feature_request.md * chore: add funding * create template for API reference issue * minor text updates * add pull requerst template * add config file * feat!: remove pull request template * chore: remove type docs label in documentation issue template Co-authored-by: Zoé <zoe@ephys.dev> * feat!: remove feature request template * chore: rename to documentation issue Co-authored-by: Zoé <zoe@ephys.dev> * chore: remove API reference Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com> * chore: update about Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com> * Delete api_references_issue.md * Rename bug_report.md to documentation_issue.md * Update config.yml * fix typo * Update config.yml * chore: forward discussion to sequelize repository instead Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com> * docs: more assertive issue template Co-authored-by: Zoé <zoe@ephys.dev> * chore: should be general Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Zoé <zoe@ephys.dev> Co-authored-by: Rik Smale <13023439+WikiRik@users.noreply.github.com>
1 parent eb9c758 commit 7f529b3

3 files changed

Lines changed: 45 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: sequelize
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Help & Questions
4+
url: https://github.com/sequelize/sequelize/discussions
5+
about: This issue tracker is for documentation issues. Use GitHub Discussions for question and help requests.
6+
- name: 🔧 Having issues with Sequelize features?
7+
url: https://github.com/sequelize/sequelize/issues/new/choose
8+
about: Please file an issue in the Sequelize repository.

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: 📗 Documentation Issue
3+
about: Documentation is unclear, or otherwise insufficient/misleading, examples aren't working as expected
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Issue Description
10+
11+
<--
12+
Try to be as clear as possible. Don't assume that the maintainers will immediately understand the problem. Write your issue in a way that new contributors can also help (add links to helpful resources when applicable).
13+
-->
14+
15+
### What was unclear/insufficient/not covered in the documentation
16+
17+
18+
19+
### If possible: Provide some suggestion on how we can enhance the docs
20+
21+
22+
23+
### Additional context
24+
25+
<-- Add any other context or screenshots about the issue here. -->

0 commit comments

Comments
 (0)