Template
1
0
mirror of https://github.com/Wessel/boilerplate.git synced 2026-07-18 06:24:20 +02:00

feat: Modernize boilerplate

This commit is contained in:
2025-03-02 13:35:48 +01:00
parent 3ee1f19c7e
commit 678ca02935
13 changed files with 98 additions and 150 deletions

2
.github/CODEOWNERS vendored
View File

@@ -1 +1 @@
* @Wessel
* @{{project.master}}

View File

@@ -1,38 +1,13 @@
# Contributing
<!---
Used linters:
[ESLint](https://eslint.org/)
[EditorConfig](https://editorconfig.org)
--->
If you wish to contribute to {{project.name}}, feel free to fork the repository and submit a pull request.
{{project.linter}} is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
so it would be much appreciated if you installed {{project.linter}} to your editor of choice
<!---
Prerequisites for Node.JS:
* [Node.JS V18.14.0](https://nodejs.org/en/)
* [Docker](https://www.docker.com)
* [ESLint](https://eslint.org)
* [(OPTIONAL) Yarn](https://yarnpkg.com)
--->
## Prerequisites
The following prerequisites must be met before installing {{project.name}}:
{{setup.prerequisites}}
<!---
Install commands:
JavaScript/TypeScript: `yarn --dev` or `npm install --dev`
Rust: `cargo run`
C: `make clean install`
Run commands:
JavaScript/TypeScript: `yarn test` or `npm run test`
Rust: `cargo run`
C: `make clean dev`
--->
## Setup
To get ready to work on the codebase, please do the following:
@@ -46,4 +21,4 @@ When creating any new functions, please also create unit tests for them in the `
Use the library associated with the project when creating such tests.
When modifying existing functions, make sure to test them before making a pull request, this will prevent
anything from breaking on the production environment.
anything from breaking on the production environment.

3
.github/FUNDING.yml vendored
View File

@@ -1,2 +1 @@
github: wessel
ko_fi: wessel
{{project.funding}}

View File

@@ -1,18 +1,12 @@
# Adapted from https://github.com/discordjs/discord.js/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml
name: Bug report
description: Report incorrect or unexpected behavior of a package
labels: [bug, need repro]
body:
# - type: markdown
# attributes:
# value: |
# Use Discord for questions: https://discord.gg/djs
- type: dropdown
id: package
attributes:
label: Which part is this bug report for?
options:
- {{tree.parts}}
options: {{tree.parts}}
validations:
required: true
- type: textarea
@@ -75,4 +69,4 @@ body:
label: I have tested this issue on a development release
placeholder: d23280c (commit hash)
description: |
The issue might already be fixed in a development release or main. This is not required, but helps us greatly.
The issue might already be fixed in a development release or main. This is not required, but helps us greatly.

View File

@@ -1,7 +1,2 @@
blank_issues_enabled: false
# Example entry:
# name:
# url:
# about:
contact_links:
- {{project.contact}}
{{project.contact}}

View File

@@ -1,4 +1,3 @@
# Adapted from https://github.com/discordjs/discord.js/blob/main/.github/ISSUE_TEMPLATE/feature_request.yml
name: Feature request
description: Request a new feature
labels: [feature request]
@@ -11,8 +10,7 @@ body:
id: package
attributes:
label: Which part is this feature request for?
options:
- {{tree.parts}}
options: {{tree.parts}}
validations:
required: false
- type: textarea
@@ -39,4 +37,4 @@ body:
id: additional-context
attributes:
label: Other context
description: Any other context, screenshots, or file uploads that help us understand your feature request.
description: Any other context, screenshots, or file uploads that help us understand your feature request.

View File

@@ -3,8 +3,6 @@ name: Pull Request
about: Propose changes to {{project.name}}
title: "[PR] Your changes"
labels: pullrequest
assignees: Wessel
---
**Please describe the changes this PR makes and why it should be merged:**

View File

@@ -1,5 +1,4 @@
addReviewers: true
reviewers:
- {{project.reviewers}}
reviewers: {{project.reviewers}}
numberOfReviewers: 0
runOnDraft: true
runOnDraft: true