diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index dbf6928456..0000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,13 +0,0 @@ -# AFFiNE CONTRIBUTING - -Contributions are **welcome** and will be fully **credited**. - -## **Requirements** - -If the project maintainer has any additional requirements, you will find them listed here. - -- Code Style [AFFiNE Code Guideline](./affine-code-guideline.md) -- Git Rules [AFFiNE Git Guideline ](./affine-git-guideline.md) -- • **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. - -**Happy coding**! diff --git a/docs/affine-code-guideline.md b/docs/affine-code-guideline.md deleted file mode 100644 index d98ba3cb51..0000000000 --- a/docs/affine-code-guideline.md +++ /dev/null @@ -1,22 +0,0 @@ -# AFFiNE Code Guideline - -| Item | Specification | Example | -| ----------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------- | -| [Packages/Paths]() | aaa-bbb-ccc | ligo-virgo, editor-todo | -| [.tsx]() | PascalCase | AddPage.tsx | -| [.ts]() | kebab-case | file-export.ts | -| [.json]() | kebab-case | file-export.ts | -| [Domain File]() | OpenRules | xx._d.ts_ | _tsconfig.xx_.json | xx.spec .ts | .env.xx | yy-ds.ts | -| [Types]() | UpperCamelCase | WebEvent | -| [Enum variants]() | UpperCamelCase | Status{ Todo,Completed } | -| [Functions]() | lowerCamelCase | | -| [React Funciton Compoment]() | UpperCamelCase | function DocShare(){} | -| [React HOC]() | UpperCamelCase | function BussinessText(){} | -| [Function Parameter]() | lowerCamelCase | function searchByIdOrName(idOrname){ } | -| [Methods for external access]() | lowerCamelCase | public sayHello(){ }; | -| [Externally Accessible Variables (Variables)]() | lowerCamelCase | animal.sleepCount | -| [General constructors]() | constructor or with_more_details | | -| [Local variables]() | lowerCamelCase | const tableCollection = []; | -| [Statics]() | SCREAMING_SNAKE_CASE | GLOBAL_MESSAGES | -| [Constants](b) | SCREAMING_SNAKE_CASE | GLOBAL_CONFIG | -| [Type parameters]() | UpperCamelCase , usually a single capital letter: T | let a: Animal = new Animal() | diff --git a/docs/affine-git-guideline.md b/docs/affine-git-guideline.md deleted file mode 100644 index 71fcb12834..0000000000 --- a/docs/affine-git-guideline.md +++ /dev/null @@ -1,91 +0,0 @@ -# AFFiNE Git Guideline - -# 1. Git Branch Name - -- fix/ -- feat/ - -# 2. **Commit message guidelines** - -AFFiNE uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated version management and package publishing. For that to work, commitmessages need to be in the right format. - -### **Atomic commits** - -If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means: - -- a commit should contain exactly one self-contained functional change -- a functional change should be contained in exactly one commit -- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...) - -A complex feature can be broken down into multiple commits as long as each one keep a consistent state and consist of a self-contained change. - -### **Commit message format** - -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: - -`(): - - - - -