toeverything/AFFiNE
1
1
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2024-11-22 08:24:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: add contributing tutorial (#1851)

Browse Source
This commit is contained in:
Himself65 2023-04-08 16:33:58 -05:00 committed by GitHub
parent 20e56cc474
commit 889503d1cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 82 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -214,6 +214,11 @@ For feature request please see [community.affine.pro](https://community.affine.p
See [BUILDING.md] for instructions on how to build AFFiNE from source code.
## Contributing
We welcome contributions from everyone.
See [docs/contributing/tutorial.md](./docs/contributing/tutorial.md) for details.
## License
See [LICENSE] for details.

32
docs/contributing/bump-blocksuite.md
View File

@ -1,32 +0,0 @@
# Bump Blocksuite
```shell
pnpm update:core
```
## Understand the version number
### Stable
You can see all the stable version tags [here](https://github.com/toeverything/blocksuite/tags).
### Nightly
If it's nightly version, the version will follow `${version}-${date}-${hash}`.
For example, `0.4.0-20230203030233-b22bea7` means that
the version is based on `0.4.0`, the building date is `20230203030233`,
and the commit hash is `b22bea7`.
> For the source code, see [here](https://github.com/toeverything/set-build-version/blob/master/src/version.ts)
Using this version format, you can easily check the diff between each version.
For example, the diff from old version `0.4.0-20230201063624-4e0463b` to new version `0.4.0-20230203030233-b22bea7`
is <https://github.com/toeverything/blocksuite/compare/4e0463b...b22bea7>.
## Fix the breaking change
You can follow this file to keep updated:
https://github.com/toeverything/blocksuite/blob/master/packages/playground/src/main.ts

77
docs/contributing/tutorial.md Normal file
View File

@ -0,0 +1,77 @@
# Tutorial
## Introduction
This tutorial will walk you through the codebase of AFFiNE. It is intended for new contributors to AFFiNE.
## Building the project
Make sure you know how to build the project. See [BUILDING](../BUILDING.md) for more information.
For the debugging purpose, you might need use local OctoBase on port 3000.
## Codebase overview
The codebase is organized as follows:
- `apps/` contains the source code for the different entry points of the project.
- `web/` contains the source code for the web app.
- `electron/` contains the source code for the Electron app.
- `server/` backend side for AFFiNE, see <https://github.com/toeverything/OctoBase> instead.
- `packages/` contains the source code for all the packages in the repo.
- `cli` contains the source code for the CLI. Development only.
- `component` contains the source code for the UI component library.
- `debug` contains the source code for the debug helper.
- `env` contains the source code for the environment setup.
- `hooks` contains the source code for the custom React hooks.
- `i18n` contains the source code for the internationalization.
- `jotai` contains the source code for the Jotai store atoms.
- `octobase-node` contains the source code for the OctoBase Node.js binding using Rust.
- `templates` contains the source code for the templates.
- `workspace` contains the source code for the workspace related code.
### `@affine/env`
Environment setup for AFFiNE client side.
It includes the global constants, browser and system check.
This package should be imported at the very beginning of the entry point.
### `@affine/workspace`
Current we have two workspace plugin:
- `local` for local workspace, which is the default workspace type.
- `affine` for cloud workspace, which is the workspace type for AFFiNE Cloud with OctoBase backend.
#### Design principles
- Each workspace plugin has its state and is isolated from other workspace plugins.
- The workspace plugin is responsible for its own state management, data persistence, synchronization, data backup and recovery.
For the workspace API, see [types.ts](../../packages/workspace/src/type.ts).
### `@affine/component`
The UI component library for AFFiNE.
Each component should be a standalone component which can be used in any context, like the Storybook.
## Debugging Environments
### `@affine/env`
```shell
yarn dev
```
### `@affine/electron`
See [building desktop client app](../building-desktop-client-app.md).
### `@affine/component` Storybook
```shell
yarn workspace @affine/component storybook
```