Skip to content

Commit

Permalink
Merge pull request #8 from penginn-net/docs
Browse files Browse the repository at this point in the history
Docs
  • Loading branch information
penginn-net authored Aug 14, 2024
2 parents 0b87dee + 98e977d commit 0ec30b4
Show file tree
Hide file tree
Showing 24 changed files with 246 additions and 89 deletions.
26 changes: 14 additions & 12 deletions .github/ISSUE_TEMPLATE/01_bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
name: 🐛 Bug Report
name: 🐛 バグ報告(bug report)
description: Create a report to help us improve
labels: ["bug?"]
labels: ["🐛bug"]

body:
- type: markdown
attributes:
value: |
報告ありがとうございます!
他のサーバーでも発生しているか、同じissueが無いか確認をお願いします
Thanks for reporting!
First, in order to avoid duplicate Issues, please search to see if the problem you found has already been reported.
Also, If you are NOT owner/admin of server, PLEASE DONT REPORT SERVER SPECIFIC ISSUES TO HERE! (e.g. feature XXX is not working in cherrypick.example) Please try with another CherryPick servers, and if your issue is only reproducible with specific server, contact your server's owner/admin first.
- type: textarea
attributes:
label: 💡 Summary
label: 💡 概要(Summary)
description: Tell us what the bug is
validations:
required: true

- type: textarea
attributes:
label: 🥰 Expected Behavior
label: 🥰 期待する動作(Expected Behavior)
description: Tell us what should happen
validations:
required: true

- type: textarea
attributes:
label: 🤬 Actual Behavior
label: 🤬 実際の動作(Actual Behavior)
description: |
Tell us what happens instead of the expected behavior.
Please include errors from the developer console and/or server log files if you have access to them.
Expand All @@ -35,7 +37,7 @@ body:

- type: textarea
attributes:
label: 📝 Steps to Reproduce
label: 📝 再現手順(Steps to Reproduce)
placeholder: |
1.
2.
Expand All @@ -45,7 +47,7 @@ body:

- type: textarea
attributes:
label: 💻 Frontend Environment
label: 💻 動作環境(Frontend Environment)
description: |
Tell us where on the platform it happens
DO NOT WRITE "latest". Please provide the specific version.
Expand All @@ -54,7 +56,7 @@ body:
* Model and OS of the device(s): MacBook Pro (14inch, 2021), macOS Ventura 13.4
* Browser: Chrome 113.0.5672.126
* Server URL: cherrypick.example.com
* CherryPick: 4.x.x (Misskey: 2024.x.x)
* CherryPick: 4.x.x-yojox.x.x (Misskey: 2024.x.x)
value: |
* Model and OS of the device(s):
* Browser:
Expand All @@ -66,15 +68,15 @@ body:

- type: textarea
attributes:
label: 🛰 Backend Environment (for server admin)
label: 🛰 動作環境(サーバー管理者向け)(Backend Environment (for server admin))
description: |
Tell us where on the platform it happens
DO NOT WRITE "latest". Please provide the specific version.
If you are using a managed service, put that after the version.
Examples:
* Installation Method or Hosting Service: docker compose, k8s/docker, systemd, "CherryPick install shell script", development environment
* CherryPick: 4.x.x (Misskey: 2024.x.x)
* CherryPick: 4.x.x-yojox.x.x (Misskey: 2024.x.x)
* Node: 20.x.x
* PostgreSQL: 15.x.x
* Redis: 7.x.x
Expand All @@ -92,6 +94,6 @@ body:

- type: checkboxes
attributes:
label: Do you want to address this bug yourself?
label: このバグを自分で修正しますか?(Do you want to address this bug yourself?)
options:
- label: Yes, I will patch the bug myself and send a pull request
- label: パッチを作成しプルリクエストします(Yes, I will patch the bug myself and send a pull request)
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/02_feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
name: ✨ Feature Request
name: 機能リクエスト(Feature Request)
description: Suggest an idea for this project
labels: ["Feature"]
labels: ["✨enhancement"]

body:
- type: textarea
attributes:
label: Summary
label: 概要(Summary)
description: Tell us what the suggestion is
validations:
required: true
- type: textarea
attributes:
label: Purpose
label: なぜ必要なのか(Purpose)
description: Describe the specific problem or need you think this feature will solve, and who it will help.
validations:
required: true
- type: checkboxes
attributes:
label: Do you want to implement this feature yourself?
label: 自分で実装しますか?(Do you want to implement this feature yourself?)
options:
- label: Yes, I will implement this by myself and send a pull request
- label: 自分で実装しプルリクエストします(Yes, I will implement this by myself and send a pull request)
16 changes: 3 additions & 13 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
contact_links:
- name: 💬 Misskey official Discord
url: https://discord.gg/Wp8gVStHW3
about: Chat freely about Misskey
#
- name: 💬 Start discussion (Misskey)
url: https://github.com/misskey-dev/misskey/discussions
about: The official forum to join conversation and ask question
- name: 💬 CherryPick official Discord
url: https://discord.gg/V8qghB28Aj
about: Chat freely about CherryPick
- name: 💬 Start discussion (CherryPick)
url: https://github.com/kokonect-link/cherrypick/discussions
about: The official forum to join conversation and ask question
- name: 💬 議論する(Start discussion)
url: https://github.com/yojo-art/cherrypick/discussions
about: 議論や質問はこちらへ(The official forum to join conversation and ask question)
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE/01_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
PR을 보내주셔서 감사합니다! PR을 작성하기 전에 기여 가이드를 먼저 확인해 주세요:
PRありがとうございます! PRを作成する前に、コントリビューションガイドをご確認ください:
Thank you for your PR! Before creating a PR, please check the contribution guide:
https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md
-->

## What
Expand All @@ -21,7 +21,7 @@ https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
<!-- Test perspective, etc -->

## Checklist
- [ ] Read the [contribution guide](https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md)
- [ ] Test working in a local environment
- [ ] (If needed) Update CHANGELOG_CHERRYPICK.md
- [ ] (If possible) Add tests
- [ ] [コントリビューションガイド](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md)を読みました( Read the [contribution guide](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md))
- [ ] ローカル環境で動作しました(Test working in a local environment)
- [ ] (必要なら)CHANGELOG_YOJO.mdの更新((If needed) Update CHANGELOG_YOJO.md)
- [ ] (必要なら)テストの追加((If possible) Add tests)
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE/02_enhance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
PR을 보내주셔서 감사합니다! PR을 작성하기 전에 기여 가이드를 먼저 확인해 주세요:
PRありがとうございます! PRを作成する前に、コントリビューションガイドをご確認ください:
Thank you for your PR! Before creating a PR, please check the contribution guide:
https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md
-->

## What
Expand All @@ -21,7 +21,7 @@ https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
<!-- Test perspective, etc -->

## Checklist
- [ ] Read the [contribution guide](https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md)
- [ ] Test working in a local environment
- [ ] (If needed) Update CHANGELOG_CHERRYPICK.md
- [ ] (If possible) Add tests
- [ ] [コントリビューションガイド](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md)を読みました( Read the [contribution guide](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md))
- [ ] ローカル環境で動作しました(Test working in a local environment)
- [ ] (必要なら)CHANGELOG_YOJO.mdの更新((If needed) Update CHANGELOG_YOJO.md)
- [ ] (必要なら)テストの追加((If possible) Add tests)
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/03_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This is a release PR.

For more information on the release instructions, please see:
https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md#release
https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md#release

## For reviewers
- CHANGELOG_CHERRYPICK에 누락된 부분은 없는가?
Expand Down
10 changes: 5 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
PR을 보내주셔서 감사합니다! PR을 작성하기 전에 기여 가이드를 먼저 확인해 주세요:
PRありがとうございます! PRを作成する前に、コントリビューションガイドをご確認ください:
Thank you for your PR! Before creating a PR, please check the contribution guide:
https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md
-->

## What
Expand All @@ -21,7 +21,7 @@ https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md
<!-- Test perspective, etc -->

## Checklist
- [ ] Read the [contribution guide](https://github.com/kokonect-link/cherrypick/blob/develop/CONTRIBUTING.md)
- [ ] Test working in a local environment
- [ ] (If needed) Update CHANGELOG_CHERRYPICK.md
- [ ] (If possible) Add tests
- [ ] [コントリビューションガイド](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md)を読みました( Read the [contribution guide](https://github.com/yojo-art/cherrypick/blob/develop/CONTRIBUTING.md))
- [ ] ローカル環境で動作しました(Test working in a local environment)
- [ ] (必要なら)CHANGELOG_YOJO.mdの更新((If needed) Update CHANGELOG_YOJO.md)
- [ ] (必要なら)テストの追加((If possible) Add tests)
30 changes: 25 additions & 5 deletions CHANGELOG_yojo.md → CHANGELOG_YOJO.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,36 @@
-

### Client
- Enhance:メンションや引用、返信の通知も削除できるように
- Fix:デッキモードで通知カラムがあるとリロードするたびに毎回通知を消すか聞かれる問題を修正
- Fix:通知を全削除できない問題を修正
- Fix:通知ポップアップにも通知削除ボタンが表示される
-

### Server
-

### Misc


## 0.5.2
Cherrypick 4.10.0-rc.3

### Release Date
2024-08-15

### General
-

### Client
- Enhance:メンションや引用、返信の通知も削除できるように [#314](https://github.com/yojo-art/cherrypick/pull/314)
- Fix:デッキモードで通知カラムがあるとリロードするたびに毎回通知を消すか聞かれる問題を修正 [#314](https://github.com/yojo-art/cherrypick/pull/314)
- Fix:通知を全削除できない問題を修正 [#314](https://github.com/yojo-art/cherrypick/pull/314)
- Fix:通知ポップアップにも通知削除ボタンが表示される [#314](https://github.com/yojo-art/cherrypick/pull/314)
- Fix: MFMでURLの表示文字列を変更した時にリモートクリップURLが書き換えられない [#324](https://github.com/yojo-art/cherrypick/pull/324)
- Enhance: リモートクリップのURLプレビューをリモートURLで生成 [#324](https://github.com/yojo-art/cherrypick/pull/324)

### Server
- Fix:withCats(ネコミミ付きのみのstreaming)がフィルタされていない問題を修正 [#323](https://github.com/yojo-art/cherrypick/pull/323)

### Misc

## 0.5.1
Cherrypick 4.10.0-rc.3

Expand All @@ -46,7 +66,7 @@ Cherrypick 4.10.0-rc.3
-

### Server
- Fix: APリクエストannounceNoteを受け取れない問題を修正
- Fix: APリクエストannounceNoteを受け取れない問題を修正 [#310](https://github.com/yojo-art/cherrypick/pull/310)

### Misc

Expand Down
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,32 +18,14 @@
<a href="./CONTRIBUTING.md">
<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-contributor-A371F7?logoColor=A371F7&style=for-the-badge&logo=git-merge&labelColor=363B40" alt="become a contributor"/></a>

<a href="https://discord.gg/V8qghB28Aj">
<img src="https://custom-icon-badges.herokuapp.com/badge/join_the-community-5865F2?logoColor=5865F2&style=for-the-badge&logo=discord&labelColor=363B40" alt="join the community"/></a>

<a href="https://www.patreon.com/noridev">
<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-patron-F96854?logoColor=F96854&style=for-the-badge&logo=patreon&labelColor=363B40" alt="become a patron"/></a>

</div>

## Thanks

<a href="https://sentry.io/"><img src="https://github.com/kokonect-link/cherrypick/assets/4439005/98576556-222f-467a-94be-e98dbda1d852" height="30" alt="Sentry" /></a>

Thanks to [Sentry](https://sentry.io/) for providing the error tracking platform that helps us catch unexpected errors.

<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" height="30" alt="Chromatic" /></a>

Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.

<a href="https://about.codecov.io/for/open-source/"><img src="https://about.codecov.io/wp-content/themes/codecov/assets/brand/sentry-cobranding/logos/codecov-by-sentry-logo.svg" height="30" alt="Codecov" /></a>

Thanks to [Codecov](https://about.codecov.io/for/open-source/) for providing the code coverage platform that helps us improve our test coverage.

<a href="https://crowdin.com/"><img src="https://user-images.githubusercontent.com/20679825/230709597-1299a011-171a-4294-a91e-355a9b37c672.svg" height="30" alt="Crowdin" /></a>

Thanks to [Crowdin](https://crowdin.com/) for providing the localization platform that helps us translate CherryPick into many languages.

<a href="https://hub.docker.com/"><img src="https://user-images.githubusercontent.com/20679825/230148221-f8e73a32-a49b-47c3-9029-9a15c3824f92.png" height="30" alt="Docker" /></a>
## このリポジトリについて
MisskeyフォークであるCherryPickから更にフォークしたソフトウェアです。
独自機能については[こちら](/doc/README.md)
同じくCherryPickフォークである縁側(v0.3.1)をマージしています
## Thanks

Thanks to [Docker](https://hub.docker.com/) for providing the container platform that helps us run CherryPick in production.
− Thanks to [縁側(engawa)](https://github.com/1673beta/cherrypick)
− Thanks to [CherryPick](https://github.com/kokonect-link/cherrypick)
− Thanks to [Misskey](https://github.com/misskey-dev/misskey)
3 changes: 2 additions & 1 deletion compose.local-db.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ services:
# volumes:
# - ./meili_data:/meili_data

# opensearchとopensearch-dashboardsのdockerfileは実装時の最新版の辞書なので適宜書き換えてください
# opensearchとopensearch-dashboardsのdockerfileは実装時の最新版の辞書なのでopensearch/dockerfileを適宜書き換えてください
# opensearchはUID:1000で実行されるので読み書きできるよう所有者を書き換える chown 1000:1000 ./data/opensearch
# opensearch:
# build: ./opensearch
# environment:
Expand Down
3 changes: 2 additions & 1 deletion compose_example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ services:
# interval: 5s
# retries: 20

# opensearchとopensearch-dashboardsのdockerfileは実装時の最新版の辞書なので適宜書き換えてください
# opensearchとopensearch-dashboardsのdockerfileは実装時の最新版の辞書なのでopensearch/dockerfileを適宜書き換えてください
# opensearchはUID:1000で実行されるので読み書きできるよう所有者を書き換える chown 1000:1000 ./data/opensearch
# opensearch:
# build: ./opensearch
# environment:
Expand Down
27 changes: 27 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
このフォークの変更の詳細は[CHENGELOG_YOJO](../CHANGELOG_YOJO.md)[CHANGELOG_engawa](../CHANGELOG_engawa.md)を参照
## yojo-art/cherrypickの独自機能
- リモートユーザー(Misskey)のクリップを見る機能
- 公開クリップ、公開投稿のみ
- マスコットウィジェット
- 管理者が指定した画像をウィジェットに表示できます
- 1ファイルあたりの容量をロールで制御
- 公式タグ機能
- インスタンスで利用が推奨されるハッシュタグ
- メディアタイムライン
- ファイルが添付された投稿のみのタイムライン
- リバーシの連合
- リモートユーザーとリバーシで対戦できます
- 対戦相手のいるサーバーも yojo-art/cherrypick互換の実装がされている必要があります
- リモートユーザーのOutboxから投稿を取得する機能
- 高度な検索
- 通常の検索に加えて以下の条件が指定できます
- クエリを利用した検索(詳しくは[こちら](./Advanced-Search.md))
- ファイルの添付状態(フィルタなし・添付あり・添付なし)
- 添付ファイルのセンシティブ状態(フィルタなし・含む・含まない・すべてセンシティブ)
- リプライ除外
- CW除外
- 引用ノート除外

## 削除された機能
- チャンネル機能
- 連合なし投稿
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cherrypick",
"version": "4.10.0-rc.3-yojo0.5.1",
"version": "4.10.0-rc.3-yojo0.5.2",
"basedMisskeyVersion": "2024.7.0",
"codename": "nasubi",
"repository": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class GlobalTimelineChannel extends Channel {
public static requireCredential = false as const;
private withRenotes: boolean;
private withFiles: boolean;
private withCats: boolean;

constructor(
private metaService: MetaService,
Expand All @@ -39,6 +40,7 @@ class GlobalTimelineChannel extends Channel {

this.withRenotes = !!(params.withRenotes ?? true);
this.withFiles = !!(params.withFiles ?? false);
this.withCats = !!(params.withCats ?? false);

// Subscribe events
this.subscriber.on('notesStream', this.onNote);
Expand All @@ -47,6 +49,7 @@ class GlobalTimelineChannel extends Channel {
@bindThis
private async onNote(note: Packed<'Note'>) {
if (this.withFiles && (note.fileIds == null || note.fileIds.length === 0)) return;
if (this.withCats && (note.user.isCat == null || note.user.isCat === false)) return;

if (note.visibility !== 'public') return;
if (note.channelId != null) return;
Expand Down
Loading

0 comments on commit 0ec30b4

Please sign in to comment.