Skip to content

Commit c9fb01a

Browse files
betterRunnerbetterRunner
authored
Merge pull request #3 from betterRunner/dev
docs:readme
2 parents 5f91884 + d42432c commit c9fb01a

3 files changed

Lines changed: 137 additions & 2 deletions

File tree

‎.github/commit-convention.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
## Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
#### TL;DR:
6+
7+
Messages must be matched by the following regex:
8+
9+
``` js
10+
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
11+
```
12+
13+
#### Examples
14+
15+
Appears under "Features" header, `theme` subheader:
16+
17+
```
18+
feat(theme): add home page feature
19+
```
20+
21+
Appears under "Bug Fixes" header, `theme` subheader, with a link to issue #28:
22+
23+
```
24+
fix(theme): remove underline on sidebar hover style
25+
26+
close #28
27+
```
28+
29+
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
30+
31+
```
32+
perf: improve store getters performance by removing 'foo' option
33+
34+
BREAKING CHANGE: The 'foo' option has been removed.
35+
```
36+
37+
The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
38+
39+
```
40+
revert: feat(theme): add home page feature
41+
42+
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
43+
```
44+
45+
### Full Message Format
46+
47+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
48+
49+
```
50+
<type>(<scope>): <subject>
51+
<BLANK LINE>
52+
<body>
53+
<BLANK LINE>
54+
<footer>
55+
```
56+
57+
The **header** is mandatory and the **scope** of the header is optional.
58+
59+
### Revert
60+
61+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
62+
63+
### Type
64+
65+
If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
66+
67+
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
68+
69+
### Scope
70+
71+
The scope could be anything specifying the place of the commit change. For example `theme`, `compiler`, `ssr`, etc...
72+
73+
### Subject
74+
75+
The subject contains a succinct description of the change:
76+
77+
* use the imperative, present tense: "change" not "changed" nor "changes"
78+
* don't capitalize the first letter
79+
* no dot (.) at the end
80+
81+
### Body
82+
83+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
84+
The body should include the motivation for the change and contrast this with previous behavior.
85+
86+
### Footer
87+
88+
The footer should contain any information about **Breaking Changes** and is also the place to
89+
reference GitHub issues that this commit **Closes**.
90+
91+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

‎.github/contributing.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Context-Note Contributing Guide
2+
3+
Hi! Thank you for joining me to build context-note together.
4+
5+
## Pull Request Guidelines
6+
7+
- Checkout a topic branch from the relevant branch, e.g. `master`, and merge back against that branch.
8+
9+
- If adding a new feature:
10+
11+
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
12+
13+
- If fixing bug:
14+
15+
- Provide a detailed description of the bug in the PR. Live demo preferred.
16+
17+
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
18+
19+
- Commit messages must follow the [commit message convention](./commit-convention.md) so that changelogs can be automatically generated.
20+
21+
## Development Setup
22+
23+
Tags: `Chrome Extension`, `Vue3`, `Vite`, `element-plus`
24+
25+
You will need [Yarn](https://classic.yarnpkg.com/en/docs/cli/install/)/
26+
27+
After cloning the repo, run:
28+
29+
```bash
30+
# install dependencies
31+
yarn
32+
```
33+
34+
### Build extension dist folder and load it in chrome browser
35+
36+
Since chrome extension does not support hrm debugging (so far as I know), we need to build the code as a dist folder and load it from chrome browser, you can read more [here](https://support.google.com/chrome_webstore/answer/2664769?hl=en) about how to load the dist folder and run the extension.
37+
38+
```bash
39+
# build extension in dev mode, where you can check source code and console info
40+
yarn dev
41+
42+
# build extension in prod mode, which is used when you finished development and ready to release it
43+
yarn build
44+
```

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ yarn build
4141
## Licence
4242

4343
Context is open source software licensed as
44-
[MIT](https://github.com/alibaba/formily/blob/master/LICENSE.md).
44+
[MIT](https://github.com/betterRunner/context-note/blob/main/LICENSE.md).
4545

4646
## Contributors
4747

48-
Sincerely invite you to build this project together!
48+
Please read the [Contributing Guide](./.github/contributing.md) for details.

0 commit comments

Comments
 (0)