Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
technote-space committed May 9, 2020
0 parents commit 688a6af
Show file tree
Hide file tree
Showing 42 changed files with 6,716 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .commitlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": [
"@commitlint/config-conventional"
]
}
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab
indent_size = 4

[{*.json,*.yml}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false
150 changes: 150 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
{
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/eslint-recommended"
],
"plugins": [
"@typescript-eslint"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"sourceType": "module",
"ecmaVersion": 2018
},
"env": {
"node": true,
"jest": true,
"es6": true,
"browser": true
},
"settings": {
"react": {
"version": "latest"
}
},
"rules": {
"camelcase": [
"error",
{
"properties": "always"
}
],
"require-jsdoc": [
"error",
{
"require": {
"FunctionDeclaration": true,
"MethodDefinition": true,
"ClassDeclaration": true
}
}
],
"valid-jsdoc": [
"error",
{
"requireReturn": false,
"preferType": {
"String": "string",
"Object": "object",
"Number": "number",
"Function": "function",
"Void": "void"
}
}
],
"quotes": [
"error",
"single",
"avoid-escape"
],
"key-spacing": [
"error",
{
"singleLine": {
"beforeColon": false,
"afterColon": true
},
"multiLine": {
"beforeColon": false,
"afterColon": true
}
}
],
"no-magic-numbers": [
"error",
{
"ignoreArrayIndexes": true
}
],
"eqeqeq": "error",
"block-scoped-var": "error",
"complexity": [
"error",
{
"maximum": 20
}
],
"curly": "error",
"default-case": "error",
"dot-location": [
"error",
"property"
],
"guard-for-in": "error",
"no-eval": "error",
"block-spacing": "error",
"brace-style": "error",
"comma-spacing": [
"error",
{
"before": false,
"after": true
}
],
"id-length": [
"error",
{
"min": 2,
"properties": "never",
"exceptions": [
"$"
]
}
],
"indent": [
"error",
"tab",
{
"MemberExpression": "off",
"SwitchCase": 1
}
],
"space-before-function-paren": [
"error",
"never"
],
"space-before-blocks": "error",
"prefer-const": "error",
"no-var": "error",
"arrow-body-style": "off",
"arrow-spacing": "error",
"strict": [
"error"
],
"no-warning-comments": [
"warn",
{
"terms": [
"todo",
"fixme",
"hack"
],
"location": "anywhere"
}
],
"semi": [
"error"
]
}
}
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @technote-space
76 changes: 76 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 technote.space@gmail.com. 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
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing
[issues]: https://github.com/technote-space/ts-package-template/issues
[fork]: https://github.com/technote-space/ts-package-template/fork
[pr]: https://github.com/technote-space/ts-package-template/compare
[eslint]: https://eslint.org/
[jest]: https://jestjs.io/
[code-of-conduct]: CODE_OF_CONDUCT.md

When contributing to this repository, please first discuss the change you wish to make via [issue][issues] with the owners of this repository before making a change.

Please note we have a [Contributor Code of Conduct][code-of-conduct], please follow it in all your interactions with the project.

## Submitting a pull request

1. [Fork][fork] and clone the repository
1. Make sure the tests pass on your machine: `yarn test`, which contains
- [`ESLint`][eslint]
- [`Jest`][jest]
1. Create a new branch: `git checkout -b my-branch-name`
1. Make your change, add tests, and make sure the tests still pass.
1. Push to your fork and [submit a pull request][pr].
1. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write and update tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message](https://github.com/erlang/otp/wiki/writing-good-commit-messages).

Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
custom: https://paypal.me/technote0space
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: 'technote-space'

---

## Describe the bug: バグの概要
<!-- A clear and concise description of what the bug is. -->
<!-- バグの内容を簡潔かつ明確に書いてください -->

## To Reproduce: 再現手順
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected behavior: 期待する動作
<!-- A clear and concise description of what you expected to happen. -->
<!-- あなたが期待する動きを簡潔かつ明確に書いてください -->

## Screenshots: スクリーンショット
<!-- If applicable, add screenshots to help explain your problem. -->
<!-- バグの説明に役立つスクリーンショットを用意できる場合、ここに追加してください -->

## Operating environment: バグが発生した環境
- Version of software
- OS: [e.g. Windows10]
- Browser: [e.g. Chrome, Safari]
- etc.

## Additional context: 補足
<!-- Add any other context about the problem here. -->
<!-- このバグに関連する情報を追加してください -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: 'technote-space'

---

## Please describe your suggestion: 提案の概要
<!-- A clear and concise description of what the problem is. e.g. I'm always frustrated when [...] -->
<!-- 『~をするときにいつもイライラする』など、現在抱えている問題の概要 -->

## Describe the solution you'd like: 考えうる解決方法
<!-- 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. -->
<!-- 補足やスクリーンショットなど -->
3 changes: 3 additions & 0 deletions .github/card-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Backlog:
'In progress':
- 'Status: In Progress'
Loading

0 comments on commit 688a6af

Please sign in to comment.