From 259d3339c4deebc38596ab22b2b1d945879ac122 Mon Sep 17 00:00:00 2001 From: matteom0165 Date: Tue, 2 Apr 2024 17:56:20 +0200 Subject: [PATCH 1/3] feat: launch config for bun --- .vscode/launch.json | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/.vscode/launch.json b/.vscode/launch.json index 0fe3ed5..bdc88ca 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -19,6 +19,21 @@ "/**" ] }, + { + "type": "node", + "request": "launch", + "name": "[bun] start", + "runtimeExecutable": "bun", + "console": "integratedTerminal", + "envFile": "${workspaceFolder}/.env", + "runtimeArgs": [ + "run", + "start:debug" + ], + "skipFiles": [ + "/**" + ] + }, { "type": "node", "request": "launch", @@ -33,6 +48,21 @@ "skipFiles": [ "/**" ] + }, + { + "type": "node", + "request": "launch", + "name": "[bun] start:dev", + "runtimeExecutable": "bun", + "console": "integratedTerminal", + "envFile": "${workspaceFolder}/.env.dev", + "runtimeArgs": [ + "run", + "start:debug" + ], + "skipFiles": [ + "/**" + ] } ] } \ No newline at end of file From 22305b44ba8a84fd5f7147269a3c81d54fcafaee Mon Sep 17 00:00:00 2001 From: Matteo Juen <45847997+Blvckleg@users.noreply.github.com> Date: Fri, 5 Apr 2024 08:55:58 +0200 Subject: [PATCH 2/3] docs: code of conduct --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8c1dda3 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +matteojuen@outlook.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From bc7737805371df866f24ac88efd5dd1b941c89fe Mon Sep 17 00:00:00 2001 From: Matteo Juen Date: Fri, 5 Apr 2024 09:10:06 +0200 Subject: [PATCH 3/3] docs: add contributing --- CONTRIBUTING.md | 198 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 198 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bbc6136 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,198 @@ +# Contributing to semantic-release + +As a contributor, here are the guidelines we would like you to follow: + +- [How can I contribute?](#how-can-i-contribute) +- [Using the issue tracker](#using-the-issue-tracker) +- [Submitting a Pull Request](#submitting-a-pull-request) +- [Coding rules](#coding-rules) +- [Git Commit Type](#git-commit-type) +- [Working with the code](#working-with-the-code) + +## How can I contribute? + +### Give feedback on issues + +Some issues are created without information requested in the [Bug report guideline](#bug-report). +Help make them easier to resolve by adding any relevant information. + +Issues with the [discussion label](https://github.com/Blvckleg/BingusBoingus/labels/discussion) are meant to discuss the implementation of new features. + +### Fix bugs and implement features + +Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/Blvckleg/BingusBoingus/labels/help%20wanted) or the [bug label](https://github.com/Blvckleg/BingusBoingus/labels/bug). + +## Using the issue tracker + +The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. + +### Bug report + +A good bug report shouldn't leave others needing to chase you for more information. +Please try to be as detailed as possible in your report and fill the information requested in the [bug report template](https://github.com/Blvckleg/BingusBoingus/blob/master/.github/ISSUE_TEMPLATE/bug_report.md). + +### Feature request + +Please provide as much detail and context as possible and fill the information requested in the [feature request template](https://github.com/Blvckleg/BingusBoingus/blob/master/.github/ISSUE_TEMPLATE/feature_request.md). + +## Submitting a Pull Request + +Good pull requests, whether patches, improvements, or new features, are a fantastic help. +They should remain focused in scope and avoid containing unrelated commits. + +Here is a summary of the steps to follow: + +1. Create issue + +2. Create issue branch from main +3. Make your code changes, following the [Coding rules](#coding-rules) +4. Push your topic branch + +```bash +git push origin +``` + +5. [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request) with a clear title and description. + +**Tips**: + +- For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community. + + +## Coding rules + +### Source code + +To ensure consistency and quality throughout the source code, all code modifications must have: + +- No [linting](#lint) errors +- A [test](#tests) for every possible case introduced by your code change +- [Valid commit message(s)](#commit-message-guidelines) +- Documentation for new features +- Updated documentation for modified features + +### Documentation + +To ensure consistency and quality, all documentation modifications must: + +- Refer to brand in [bold](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) with proper capitalization, i.e. **GitHub**, **Nestjs**, **npm** +- Prefer [tables](https://help.github.com/articles/organizing-information-with-tables) over [lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#lists) when listing key values, i.e. List of options with their description +- Use [links](https://help.github.com/articles/basic-writing-and-formatting-syntax/#links) when you are referring to: +- Use the [single backtick `code` quoting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) for: + - programming language keywords, i.e. `function`, `async`, `String` +- Use the [triple backtick `code` formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks) for: + - code examples + - configuration examples + - sequence of command lines + +### Commit message guidelines + +#### Atomic commits + +If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means: + +- a commit should contain exactly one self-contained functional change +- a functional change should be contained in exactly one commit +- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...) + +A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change. + +#### Commit message format + +Each commit message consists of a **header**, a **body** and a **footer**. +The header has a special format that includes a **type**, a **scope** and a **subject**: + +```commit +(): + + + +