mirrors/barkey
1
0
Fork 0
mirror of https://codeberg.org/yeentown/barkey.git synced 2025-04-28 01:26:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: run more tests after merging

Browse source 
also, reformat the markdown to get the correct list nesting
This commit is contained in:
dakkar 2025-02-06 10:45:13 +00:00
parent 67ff1969b0
commit f2382e951e
1 changed files with 28 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
CONTRIBUTING.md
View file

@ -660,23 +660,23 @@ seems to do a decent job)
*after that commit*, do all the extra work, on the same branch: *after that commit*, do all the extra work, on the same branch:
* copy all changes (commit after each step): * copy all changes (commit after each step):
* in * in
`packages/backend/src/core/activitypub/models/ApNoteService.ts`, `packages/backend/src/core/activitypub/models/ApNoteService.ts`,
from `createNote` to `updateNote` from `createNote` to `updateNote`
* from `packages/backend/src/core/NoteCreateService.ts` to * from `packages/backend/src/core/NoteCreateService.ts` to
`packages/backend/src/core/NoteEditService.ts` `packages/backend/src/core/NoteEditService.ts`
* from `packages/backend/src/server/api/endpoints/notes/create.ts` * from `packages/backend/src/server/api/endpoints/notes/create.ts`
to `packages/backend/src/server/api/endpoints/notes/edit.ts` to `packages/backend/src/server/api/endpoints/notes/edit.ts`
* from `packages/frontend/src/components/MkNote*.vue` to * from `packages/frontend/src/components/MkNote*.vue` to
`packages/frontend/src/components/SkNote*.vue` (if sensible) `packages/frontend/src/components/SkNote*.vue` (if sensible)
* from the global timeline to the bubble timeline * from the global timeline to the bubble timeline
(`packages/backend/src/server/api/stream/channels/global-timeline.ts`, (`packages/backend/src/server/api/stream/channels/global-timeline.ts`,
`packages/backend/src/server/api/stream/channels/bubble-timeline.ts`, `packages/backend/src/server/api/stream/channels/bubble-timeline.ts`,
`packages/frontend/src/timelines.ts`, `packages/frontend/src/timelines.ts`,
`packages/frontend/src/components/MkTimeline.vue`, `packages/frontend/src/components/MkTimeline.vue`,
`packages/frontend/src/pages/timeline.vue`, `packages/frontend/src/pages/timeline.vue`,
`packages/frontend/src/ui/deck/tl-column.vue`, `packages/frontend/src/ui/deck/tl-column.vue`,
`packages/frontend/src/widgets/WidgetTimeline.vue`) `packages/frontend/src/widgets/WidgetTimeline.vue`)
* if there have been any changes to the federated user data (the * if there have been any changes to the federated user data (the
`renderPerson` function in `renderPerson` function in
`packages/backend/src/core/activitypub/ApRendererService.ts`), make `packages/backend/src/core/activitypub/ApRendererService.ts`), make
@ -692,19 +692,20 @@ seems to do a decent job)
build` (the `development` tells it to keep some of the original build` (the `development` tells it to keep some of the original
filenames in the built files) filenames in the built files)
* make sure there aren't any new `ti-*` classes (Tabler Icons), and * make sure there aren't any new `ti-*` classes (Tabler Icons), and
replace them with appropriate `ph-*` ones (Phosphor Icons) in [`vite.replaceicons.ts`](packages/frontend/vite.replaceIcons.ts). replace them with appropriate `ph-*` ones (Phosphor Icons) in
This command should show you want to change: `grep -ohrP '(?<=["'\'']ti )(ti-(?!fw)[\w\-]+)' --exclude \*.map -- built/ | sort -u`. [`vite.replaceicons.ts`](packages/frontend/vite.replaceIcons.ts).
* NOTE: `ti-fw` is a special class that's defined by Misskey, leave it alone. This command should show you want to change: `grep -ohrP
* After every change, re-build the frontend and check again, until '(?<=["'\'']ti )(ti-(?!fw)[\w\-]+)' --exclude \*.map -- built/ |
there are no more `ti-*` classes in the built files. sort -u`.
* Commit! * NOTE: `ti-fw` is a special class that's defined by Misskey, leave it alone.
* After every change, re-build the frontend and check again, until
there are no more `ti-*` classes in the built files.
* Commit!
* double-check the new migration, that they won't conflict with our db * double-check the new migration, that they won't conflict with our db
changes: `git diff develop -- packages/backend/migration/` changes: `git diff develop -- packages/backend/migration/`
* `pnpm clean; pnpm build` * `pnpm clean; pnpm build`
* run tests `pnpm --filter='!megalodon' test; pnpm --filter backend * run tests `pnpm test; pnpm --filter backend test:e2e` (requires a
test:e2e` (requires a test database, [see above](#testing)) and fix test database, [see above](#testing)) and fix as much as you can
as much as you can
* right now `megalodon` doesn't pass its tests, so we skip them
* run lint `pnpm --filter=backend --filter=frontend-shared lint` + * run lint `pnpm --filter=backend --filter=frontend-shared lint` +
`pnpm --filter=frontend --filter=frontend-embed eslint` and fix as `pnpm --filter=frontend --filter=frontend-embed eslint` and fix as
much as you can much as you can