Initial commit

This commit is contained in:
2023-02-07 21:15:43 +01:00
committed by GitHub
commit 769fddc4c3
15 changed files with 417 additions and 0 deletions

12
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,12 @@
# Contributing
If you wish to contribute to $(PROJECT_NAME), feel free to fork the repository and submit a pull request.
[ESLint](https://eslint.org/) is enforced to correct most typo's you make and keep the code style the same throughout the whole project, so it would be appreciated if you installed [ESLint](https://eslint.org/) to your editor of choice
## Setup
To get ready to work on the codebase, please do the following:
1. Fork & clone the repository, and make sure you're on the **master** branch
2. Run `yarn --dev` or `npm install --dev`
4. Code your heart out and test using `yarn test` or `npm run test`
6. [Submit a pull request](https://github.com/Wessel/$(PROJECT_NAME)/compare)

2
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,2 @@
patreon: wessel
ko_fi: wessel

27
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,27 @@
---
name: Bug Report
about: Report an issue with $(PROJECT_NAME)
title: "[BUG] Bug summed up in 1 sentence"
labels: bug
assignees: Wessel
---
**Please describe the problem you are having in as much detail as possible:**
**Include a reproducible code sample here, if possible:**
```js
// Place your code here
```
**Further details:**
- $(PROJECT_NAME) version:
- Node.js version:
- Operating system:
<!--
If this applies to you, please check the respective checkbox: [ ] becomes [x].
-->
- [ ] I have also tested the issue on latest master, commit hash:

View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Request a feature for $(PROJECT_NAME)
title: "[ENHANCEMENT] Your idea"
labels: enhancement
assignees: Wessel
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the ideal solution**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

19
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,19 @@
---
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:**
**Status**
- [ ] Code changes have been tested and there aren't any typos in it
**Semantic versioning classification:**
- [ ] This PR changes $(PROJECT_NAME) core codebase (methods or parameters added)
- [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.