1
0
mirror of https://github.com/Wessel/boilerplate-c.git synced 2026-06-06 02:35:46 +02:00

Initial commit

This commit is contained in:
2023-02-06 14:01:16 +01:00
committed by GitHub
commit 5f7d41f1a6
15 changed files with 417 additions and 0 deletions

8
.editorconfig Normal file
View File

@@ -0,0 +1,8 @@
root = true
[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

2
.eslintignore Normal file
View File

@@ -0,0 +1,2 @@
node_modules/
dist/

65
.eslintrc Normal file
View File

@@ -0,0 +1,65 @@
{
"env": {
"es6": true,
"amd": true,
"node": true,
"mongo": true,
"jquery": true,
"browser": true,
"commonjs": true
},
"parserOptions": {
"ecmaVersion": 9,
"sourceType": "module",
"ecmaFeatures": {
"jsx": true,
"forOf": true,
"spread": true,
"modules": true,
"classes": true,
"generators": true,
"restParams": true,
"regexUFlag": true,
"regexYFlag": true,
"globalReturn": true,
"destructuring": true,
"impliedStrict": true,
"blockBindings": true,
"defaultParams": true,
"octalLiterals": true,
"arrowFunctions": true,
"binaryLiterals": true,
"templateStrings": true,
"superInFunctions": true,
"unicodeCodePointEscapes": true,
"experimentalObjectRestSpread": true,
"objectLiteralShorthandMethods": true,
"objectLiteralComputedProperties": true,
"objectLiteralDuplicateProperties": true,
"objectLiteralShorthandProperties": true
}
},
"plugins": [],
"rules": {
"semi": "warn",
"indent": [ "off", "error" ],
"strict": "off",
"eqeqeq": "error",
"no-var": "warn",
"no-undef": "warn",
"valid-jsdoc": "warn",
"comma-dangle": "warn",
"no-dupe-args": "warn",
"no-dupe-keys": "warn",
"require-await": "warn",
"spaced-comment": "error",
"space-in-parens": "error",
"no-global-assign": "warn",
"no-duplicate-imports": "error",
"no-dupe-class-members": "error"
},
"globals": {
"_config": false,
"console": false
}
}

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto

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.

3
.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
tmp/
src/tmp
node_modules/

144
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,144 @@
/*
? Extensions: rainglow, eslint, material icon theme, gitlens, fish-vscode, Docker, EditorConfig for VS Code
? Popping and Locking theme, Sass, stylelint, SVG viewer, Trailing spaces, Auto renaming tags, Better Comments,
? Regex previewer
* Color themes: Banner (rainglow), Hyrule (rainglow), Azure (rainglow), Github (rainglow),
* Heroku (rainglow), Popping and Locking
* Comment legend:
/ Info
* Note
? Question
! Somenthing's wrong
> Changed
+ Added
- Removed
todo TODO
*/
{
"window.zoomLevel": 0,
"editor.fontSize": 13,
"editor.fontWeight": "200",
"editor.fontFamily": "'SFMono-Regular','Consolas','Liberation Mono','Menlo','Courier','monospace','Operator Mono SSm Lig','OperatorMonoSSmLig-Book'",
"editor.lineHeight": 20,
"editor.cursorStyle": "line",
"editor.lineNumbers": "relative",
"editor.cursorWidth": 0,
"editor.fontLigatures": true,
"editor.cursorBlinking": "blink",
"editor.minimap.enabled": true,
"editor.smoothScrolling": true,
"editor.multiCursorModifier": "ctrlCmd",
"editor.minimap.renderCharacters": true,
"editor.tabSize": 2,
"editor.autoIndent": "advanced",
"editor.insertSpaces": true,
"editor.tabCompletion": "on",
"editor.formatOnPaste": true,
"editor.detectIndentation": false,
"editor.wordWrap": "off",
"editor.matchBrackets": "always",
"editor.renderWhitespace": "none",
"editor.autoClosingBrackets": "always",
"editor.tokenColorCustomizations": {
"types": "#C59F61",
"strings": "#F6EB90",
"numbers": "#C54121",
"keywords": "#C59F49",
"comments": "#6a737d",
"variables": "#C55F45",
"functions": "#C59F55"
},
"workbench.iconTheme": "material-icon-theme",
"workbench.colorTheme": "Darkside (rainglow)",
"workbench.editor.showTabs": true,
"workbench.statusBar.visible": true,
"workbench.editor.tabSizing": "fit",
"workbench.sideBar.location": "left",
"debug.toolBarLocation": "floating",
"debug.allowBreakpointsEverywhere": true,
"terminal.integrated.shell.windows": "C:\\Windows\\System32\\bash.exe", // C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\powershell.exe
"files.autoSave": "off",
"files.exclude": {
"**/.git": false,
"**/.svn": false,
"**/.hg": false,
"**/CVS": false,
"**/.DS_Store": false
},
"breadcrumbs.enabled": true,
"breadcrumbs.filePath": "last",
"breadcrumbs.symbolPath": "on",
"breadcrumbs.symbolSortOrder": "name",
"git.enableSmartCommit": true,
"git.ignoreLimitWarning": true,
"eslint.enable": true,
"eslint.packageManager": "yarn",
"[yaml]": {
"editor.tabSize": 2,
"editor.autoIndent": "advanced",
"editor.insertSpaces": true
},
"[markdown]": {
"editor.wordWrap": "on",
"editor.quickSuggestions": false
},
"liveshare.featureSet": "insiders",
"better-comments.tags": [
{
"tag": "/",
"color": "#008080",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "+",
"color": "#00ff00",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": ">",
"color": "#FF00FF",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "-",
"color": "#ff0000",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "!",
"color": "#FF2D00",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "?",
"color": "#3498DB",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "//",
"color": "#474747",
"strikethrough": true,
"backgroundColor": "transparent"
},
{
"tag": "todo",
"color": "#FF8C00",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "*",
"color": "#98C379",
"strikethrough": false,
"backgroundColor": "transparent"
}
]
}

1
CODEOWNERS Normal file
View File

@@ -0,0 +1 @@
* @Wessel

76
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at discord@go2it.eu. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

22
LICENSE Normal file
View File

@@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2020 Wessel "Wessel" T <discord@go2it.eu>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

14
README.md Normal file
View File

@@ -0,0 +1,14 @@
<img src="$(LOGO_SQUARE).svg" align="left" width="192px" height="192px"/>
<img align="left" width="0" height="192px" hspace="10"/>
> $(PROJECT_NAME)
[![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square)](/LICENSE) $(BADGES)
$(SMALL_DESC)
<br>
## Table of contents
* $(HEADER)
* $(SUB_HEADER)