Skip to content

Commit 3ee974f

Browse files
Copilotcyanzhong
andauthored
Add development guidelines to README (#43)
* Initial plan * Add development instructions to README Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com> * Add Contribution section to README Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com> * Add trailing newline at end of README Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>
1 parent 96441cc commit 3ee974f

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,34 @@ https://writewithharper.com/docs/rules
5151
## Dictionary
5252

5353
When `addToDict` is enabled (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary persisted at `~/Library/Containers/app.cyan.markedit/Data/Documents/proofreading-dict.txt`. Dictionary words are automatically loaded when the extension starts.
54+
55+
## Development
56+
57+
Install dependencies:
58+
59+
```sh
60+
yarn install
61+
```
62+
63+
Lint the codebase with [ESLint](https://eslint.org/):
64+
65+
```sh
66+
yarn lint
67+
```
68+
69+
Run the test suite with [Vitest](https://vitest.dev/):
70+
71+
```sh
72+
yarn test
73+
```
74+
75+
Build the extension (runs lint, tests, then [Vite](https://vite.dev/)):
76+
77+
```sh
78+
yarn build
79+
```
80+
81+
## Contribution
82+
83+
Bug fix pull requests are generally welcome. For feature additions or behavior changes, please open a discussion or issue first so the approach can be agreed upon before any work begins.
84+

0 commit comments

Comments
 (0)