Skip to content

Commit

Permalink
🎉 feat(project): init (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
DariuszPorowski authored May 30, 2023
1 parent 331acc6 commit d4d3c3f
Show file tree
Hide file tree
Showing 54 changed files with 9,274 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true

[*.{cmd,bat}]
end_of_line = crlf
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/dist
/lib
node_modules/
jest.config.js
75 changes: 75 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# yaml-language-server: $schema=https://json.schemastore.org/eslintrc.json
---
root: true

plugins:
- jest
- '@typescript-eslint'
extends:
- plugin:github/recommended
- plugin:@typescript-eslint/recommended
parser: '@typescript-eslint/parser'
parserOptions:
ecmaVersion: 9
sourceType: module
project: ./tsconfig.json
rules:
semi: off
i18n-text/no-en: off
eslint-comments/no-use: off
import/no-namespace: off
no-unused-vars: off
'@typescript-eslint/no-unused-vars': error
'@typescript-eslint/explicit-member-accessibility':
- error
- accessibility: no-public
'@typescript-eslint/no-require-imports': error
'@typescript-eslint/array-type': error
'@typescript-eslint/await-thenable': error
'@typescript-eslint/ban-ts-comment': error
camelcase: off
'@typescript-eslint/consistent-type-assertions': error
'@typescript-eslint/explicit-function-return-type':
- error
- allowExpressions: true
'@typescript-eslint/func-call-spacing':
- error
- never
'@typescript-eslint/no-array-constructor': error
'@typescript-eslint/no-empty-interface': error
'@typescript-eslint/no-explicit-any': error
'@typescript-eslint/no-extraneous-class': error
'@typescript-eslint/no-for-in-array': error
'@typescript-eslint/no-inferrable-types': error
'@typescript-eslint/no-misused-new': error
'@typescript-eslint/no-namespace': error
'@typescript-eslint/no-non-null-assertion': warn
'@typescript-eslint/no-unnecessary-qualifier': error
'@typescript-eslint/no-unnecessary-type-assertion': error
'@typescript-eslint/no-useless-constructor': error
'@typescript-eslint/no-var-requires': error
'@typescript-eslint/prefer-for-of': warn
'@typescript-eslint/prefer-function-type': warn
'@typescript-eslint/prefer-includes': error
'@typescript-eslint/prefer-string-starts-ends-with': error
'@typescript-eslint/promise-function-async': error
'@typescript-eslint/require-array-sort-compare': error
'@typescript-eslint/restrict-plus-operands': error
'@typescript-eslint/semi':
- error
- never
'@typescript-eslint/type-annotation-spacing': error
'@typescript-eslint/unbound-method': error
overrides:
- files:
- './**/*.test.ts'
- './**/*.spec.ts'
- './tests/setup.ts'
- './tests/helpers.ts'
rules:
'@typescript-eslint/no-explicit-any': off
env:
node: true
es2018: true
jest/globals: true
jest: true
19 changes: 19 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Set default behavior to automatically normalize line endings.
* text=auto eol=lf

# Force batch scripts to always use CRLF line endings so that if a repo is accessed
# in Windows via a file share from Linux, the scripts will work.
*.{cmd,[cC][mM][dD]} text eol=crlf
*.{bat,[bB][aA][tT]} text eol=crlf

# Force bash scripts to always use LF line endings so that if a repo is accessed
# in Unix via a file share from Windows, the scripts will work.
*.sh text eol=lf

# Common files config
*.jpg -text
*.png -text
*.gif -text
*.pdf -text

dist/** -diff linguist-generated=true
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @raven-actions/reviewers
77 changes: 77 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# 🔰 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, caste, color, 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's 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 with this Code of Conduct and will communicate reasons for moderation decisions when appropriate.

## 🔭 Scope

This Code of Conduct applies within all community spaces and when an individual officially represents the community in public spaces. Representing our community includes 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 the enforcement using the [LinkedIn message](https://www.linkedin.com/in/DariuszPorowski). All complaints will be reviewed and investigated promptly and fairly.

All community leaders must 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 and 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](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations/).
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 👥 Contributing Guide

I appreciate your interest in contributing to the project! This document outlines how to contribute to the project, including the contribution process, code style, and testing.

## 🔄️ Contribution process

To contribute, please follow these steps:

1. Fork the project repository on GitHub.
1. Create a new branch for your feature or bug fix.
1. Make sure the `README.md` and any other relevant documentation are kept up-to-date.
1. Make your changes and commit them with descriptive commit messages; check [Conventional Commits](https://www.conventionalcommits.org) as a suggestion.
1. Push to your forked repository.
1. Create a new pull request from your fork to this project.
1. Please ensure that your Pull Request includes a detailed description of your changes.

## 🔰 Code of Conduct

All contributors are expected to adhere to the project name code of conduct. Therefore, please review it before contributing [`Code of Conduct`](CODE_OF_CONDUCT.md).

## 🛡️ License

By contributing to this project, you agree that your contributions will be licensed under the project license.

Thank you for contributing!
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
---
name: 🐛 Bug Report
description: If something isn't working 🔧
title: '🐛 [bug]: '
labels: [bug]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: 🐛 What happened?
description: A clear and concise description of what the bug is.
placeholder: Describe what happened
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: 🔬 How to reproduce?
description: Steps to reproduce the behavior.
placeholder: |
1. ...
2. ...
validations:
required: false
- type: textarea
id: code-sample
attributes:
label: 🏗️ Code Sample / Log
description: Please copy and paste any relevant code sample / log output.
render: Shell
placeholder: This will be automatically formatted into code, so no need for backticks.
validations:
required: false
- type: input
id: action-version
attributes:
label: 🌌 Environment (`environment-variables` action)
description: What `environment-variables` action version are you running?
placeholder: 1.0.0
validations:
required: true
- type: dropdown
id: gh
attributes:
label: 🌌 Environment (GitHub)
description: What GitHub instance are you running?
options:
- GitHub
- GitHub Enterprise Cloud
- GitHub Enterprise Server
- type: dropdown
id: os
attributes:
label: 🌌 Environment (GitHub Runner OS)
description: What OS are you running?
options:
- Linux
- Windows
- macOS
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: 📷 Screenshots
description: If applicable, add screenshots to help explain your problem.
placeholder: Just do Ctrl+V having screenshot in the clipboard.
validations:
required: false
- type: textarea
id: expected-behavior
attributes:
label: 📈 Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 📎 Additional context
description: Add any other context about the problem here.
placeholder: Add any other context about the problem here.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: 🔰 Code of Conduct
description: By submitting this issue, you agree to follow our [`Code of Conduct`](../blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-config.json
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
---
blank_issues_enabled: false
# contact_links:
# - name: Support
# url: https://www.linkedin.com/in/DariuszPorowski
# about: Request support
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
---
name: ✨ Feature request
description: Suggest an idea for this project 🏖
title: '✨ [feature]: '
labels: [enhancement]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this new feature idea!
- type: textarea
id: description
attributes:
label: ✨ Feature description
description: A clear and concise description of the feature proposal.
placeholder: A clear and concise description of the feature proposal.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: 🔈 Motivation
description: Please describe the motivation for this proposal.
placeholder: Please describe the motivation for this proposal.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: 🛰 Alternatives
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: 📎 Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: 🔰 Code of Conduct
description: By submitting this issue, you agree to follow our [`Code of Conduct`](../blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct.
required: true
Loading

0 comments on commit d4d3c3f

Please sign in to comment.