forked from FoundKeyGang/FoundKey
remove unneeded files from foundkey-js
This commit is contained in:
parent
41414b4576
commit
0fd89e3ab7
GPG key ID:
9EE6577A2A06F8F1
2 changed files with 0 additions and 218 deletions
|
|
@ -1,128 +0,0 @@
|
||||||
# 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
|
|
||||||
syuilotan@yahoo.co.jp.
|
|
||||||
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.
|
|
||||||
|
|
@ -1,90 +0,0 @@
|
||||||
# Contribution guide
|
|
||||||
**[✨ English version available](/docs/CONTRIBUTING.en.md)**
|
|
||||||
|
|
||||||
プロジェクトに興味を持っていただきありがとうございます！
|
|
||||||
このドキュメントでは、プロジェクトに貢献する際に必要な情報をまとめています。
|
|
||||||
|
|
||||||
## 実装をする前に
|
|
||||||
機能追加やバグ修正をしたいときは、まずIssueなどで設計、方針をレビューしてもらいましょう(無い場合は作ってください)。このステップがないと、せっかく実装してもPRがマージされない可能性が高くなります。
|
|
||||||
|
|
||||||
また、実装に取り掛かるときは当該Issueに自分をアサインしてください(自分でできない場合は他メンバーに自分をアサインしてもらうようお願いしてください)。
|
|
||||||
自分が実装するという意思表示をすることで、作業がバッティングするのを防ぎます。
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
Issueを作成する前に、以下をご確認ください:
|
|
||||||
- 重複を防ぐため、既に同様の内容のIssueが作成されていないか検索してから新しいIssueを作ってください。
|
|
||||||
- Issueを質問に使わないでください。
|
|
||||||
- Issueは、要望、提案、問題の報告にのみ使用してください。
|
|
||||||
- 質問は、[Misskey Forum](https://forum.misskey.io/)や[Discord](https://discord.gg/Wp8gVStHW3)でお願いします。
|
|
||||||
|
|
||||||
## PRの作成
|
|
||||||
PRを作成する前に、以下をご確認ください:
|
|
||||||
- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
|
|
||||||
- fix / refactor / feat / enhance / perf / chore 等
|
|
||||||
- また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
|
|
||||||
- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
|
|
||||||
- [`CHANGELOG.md`](/CHANGELOG.md)に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
|
|
||||||
- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
|
|
||||||
- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
|
|
||||||
- テスト、Lintが通っていることを予め確認してください。
|
|
||||||
- `npm run test`、`npm run lint`でぞれぞれ実施可能です
|
|
||||||
- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
|
|
||||||
- APIレポートの詳細については[こちら](#api-extractor)
|
|
||||||
|
|
||||||
ご協力ありがとうございます🤗
|
|
||||||
|
|
||||||
## Tools
|
|
||||||
### eslint
|
|
||||||
このプロジェクトではコードのフォーマットチェック/整形に[eslint](https://eslint.org/)を導入しています。
|
|
||||||
CI上でも自動でチェックされ、ルールに則っていないコードがあるとエラーになります。
|
|
||||||
|
|
||||||
### Jest
|
|
||||||
このプロジェクトではテストフレームワークとして[Jest](https://jestjs.io/)を導入しています。
|
|
||||||
テストは[`/test`ディレクトリ](/test)に置かれます。
|
|
||||||
|
|
||||||
テストはCIにより各コミット/各PRに対して自動で実施されます。
|
|
||||||
ローカル環境でテストを実施するには、`npm run test`を実行してください。
|
|
||||||
|
|
||||||
### tsd
|
|
||||||
このプロジェクトでは型のテストを行うために[tsd](https://github.com/SamVerschueren/tsd)を導入しています。
|
|
||||||
Jestによるテストでは「型が期待したものか」というのはチェックすることができません。tsdを使うことで、型が意図したものであることを担保することができます。
|
|
||||||
tsdによる型テストは[`/test-d`ディレクトリ](/test-d)に置かれます。
|
|
||||||
|
|
||||||
テストはCIにより各コミット/各PRに対して自動で実施されます。
|
|
||||||
ローカル環境でテストを実施するには、`npm run test`を実行してください。
|
|
||||||
|
|
||||||
### API Extractor
|
|
||||||
このプロジェクトでは[API Extractor](https://api-extractor.com/)を導入しています。API ExtractorはAPIレポートを生成する役割を持ちます。
|
|
||||||
APIレポートはいわばAPIのスナップショットで、このライブラリが外部に公開(export)している各種関数や型の定義が含まれています。`npm run api`コマンドを実行すると、その時点でのレポートが[`/etc`ディレクトリ](/etc)に生成されるようになっています。
|
|
||||||
|
|
||||||
exportしているAPIに変更があると、当然生成されるレポートの内容も変わるので、例えばdevelopブランチで生成されたレポートとPRのブランチで生成されたレポートを比較することで、意図しない破壊的変更の検出や、破壊的変更の影響確認に用いることができます。
|
|
||||||
また、各コミットや各PRで実行されるCI内部では、都度APIレポートを生成して既存のレポートと差分が無いかチェックしています。もし差分があるとエラーになります。
|
|
||||||
|
|
||||||
PRを作る際は、`npm run api`コマンドを実行してAPIレポートを生成し、差分がある場合はコミットしてください。
|
|
||||||
レポートをコミットすることでその破壊的変更が意図したものであると示すことができるほか、上述したようにレポート間の差分が出ることで影響範囲をレビューしやすくなります。
|
|
||||||
|
|
||||||
### Codecov
|
|
||||||
このプロジェクトではカバレッジの計測に[Codecov](https://about.codecov.io/)を導入しています。カバレッジは、コードがどれくらいテストでカバーされているかを表すものです。
|
|
||||||
|
|
||||||
カバレッジ計測はCIで自動的に行われ、特に操作は必要ありません。カバレッジは[ここ](https://codecov.io/gh/misskey-dev/misskey.js)から見ることができます。
|
|
||||||
|
|
||||||
また、各PRに対してもそのブランチのカバレッジが自動的に計算され、マージ先のカバレッジとの差分を含んだレポートがCodecovのbotによりコメントされます。これにより、そのPRをマージすることでどれくらいカバレッジが増加するのか/減少するのかを確認することができます。
|
|
||||||
|
|
||||||
## レビュイーの心得
|
|
||||||
[PRのセクション](#PRの作成)をご一読ください。
|
|
||||||
また、後述の「レビュー観点」も意識してみてください。
|
|
||||||
|
|
||||||
## レビュワーの心得
|
|
||||||
- 直して欲しい点だけでなく、良い点も積極的にコメントしましょう。
|
|
||||||
- 貢献するモチベーションアップに繋がります。
|
|
||||||
|
|
||||||
### レビュー観点
|
|
||||||
- セキュリティ
|
|
||||||
- このPRをマージすることで、脆弱性を生まないか？
|
|
||||||
- パフォーマンス
|
|
||||||
- このPRをマージすることで、予期せずパフォーマンスが悪化しないか？
|
|
||||||
- もっと効率的な方法は無いか？
|
|
||||||
- テスト
|
|
||||||
- 期待する振る舞いがテストで担保されているか？
|
|
||||||
- 抜けやモレは無いか？
|
|
||||||
- 異常系のチェックは出来ているか？
|
|
||||||
Loading…
Reference in a new issue