summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2023-08-27 09:45:23 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2023-08-27 09:45:23 +0900
commitf5a5d591557eeed9f163cda8baf2538e142379a9 (patch)
tree2425c5bceecad7e66fc813b9454b43455a2135ee /CONTRIBUTING.md
parentbuild(deps): bump cypress-io/github-action from 5 to 6 (#11758) (diff)
downloadsharkey-f5a5d591557eeed9f163cda8baf2538e142379a9.tar.gz
sharkey-f5a5d591557eeed9f163cda8baf2538e142379a9.tar.bz2
sharkey-f5a5d591557eeed9f163cda8baf2538e142379a9.zip
Update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62bc11cd99..e81fecf357 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -301,6 +301,12 @@ export const handlers = [
Don't forget to re-run the `.storybook/generate.js` script after adding, editing, or removing the above files.
## Notes
+
+### Misskeyのドメイン固有の概念は`Mi`をprefixする
+例えばGoogleが自社サービスをMap、Earth、DriveではなくGoogle Map、Google Earth、Google Driveのように命名するのと同じ
+コード上でMisskeyのドメイン固有の概念には`Mi`をprefixすることで、他のドメインの同様の概念と区別できるほか、名前の衝突を防ぐ。
+ただし、文脈上Misskeyのものを指すことが明らかであり、名前の衝突の恐れがない場合は、一時的なローカル変数に限って`Mi`を省略してもよい。
+
### How to resolve conflictions occurred at pnpm-lock.yaml?
Just execute `pnpm` to fix it.