You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/zh/contributing.md
+28-15Lines changed: 28 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,23 @@ First off, thanks for wanting to contribute to the Spaced Repetition plugin!
10
10
11
11
## Translating
12
12
13
+
The plugin has been translated into the following languages by the Obsidian community 😄.
14
+
15
+
- Arabic / العربية
16
+
- Chinese (Simplified) / 简体中文
17
+
- Chinese (Traditional) / 繁體中文
18
+
- Czech / čeština
19
+
- French / français
20
+
- German / Deutsch
21
+
- Italian / Italiano
22
+
- Korean / 한국어
23
+
- Japanese / 日本語
24
+
- Polish / Polski
25
+
- Portuguese (Brazil) / Português do Brasil
26
+
- Spanish / Español
27
+
- Russian / русский
28
+
- Turkish / Türkçe
29
+
13
30
### Steps
14
31
15
32
To help translate the plugin to your language:
@@ -56,10 +73,12 @@ Please note that:
56
73
1. Only the strings(templates) on the right of the key should be translated.
57
74
2. Text inside `${}` isn't translated. This is used to replace variables in code. For instance, if interval = 4, it becomes `4 days` in English & `Siku 4` in Swahili. Quite nifty if you ask me.
58
75
76
+
---
77
+
59
78
## Code
60
79
61
80
1. Make your changes.
62
-
2. Run `pnpm dev` to test the changes inside Obsidian.
81
+
2. Run `pnpm dev` to watch for changes & rebuild the plugin automatically.
63
82
3. You could create symbolic links between the build files and the Obsidian vault, example:
64
83
65
84
```bash
@@ -77,19 +96,11 @@ Please note that:
77
96
5. If your "business logic" is properly decoupled from Obsidian APIs, write some unit tests.
78
97
- This project uses [jest](https://jestjs.io/), tests are stored in`tests/`.
79
98
- `pnpm test`
80
-
6. Add your change to the `[Unreleased]` section of the changelog (`docs/docs/changelog.md`).
81
-
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), TL;DR:
82
-
- `Added`for new features.
83
-
- `Changed`forchangesin existing functionality.
84
-
- `Deprecated`for soon-to-be removed features.
85
-
- `Removed`for now removed features.
86
-
- `Fixed`for any bug fixes.
87
-
- `Security`incase of vulnerabilities.
88
-
- You can also append a link to your GitHub profile, example:
89
-
- `Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)`
90
-
7. Before pushing your changes, run the linter: `pnpm lint`
99
+
6. Before pushing your changes, run the linter: `pnpm lint`
91
100
- Format the code incase any warnings are raised: `pnpm format`
92
-
8. Open the pull request.
101
+
7. Open the pull request.
102
+
103
+
---
93
104
94
105
## Documentation
95
106
@@ -126,6 +137,8 @@ For larger diffs, it's important that you check how your docs look like as expla
126
137
3. Copy the files from the English (`en`) folder into the new folder.
127
138
4. Translate then open a pull request.
128
139
140
+
---
141
+
129
142
## Maintenance
130
143
131
144
### Releases
@@ -144,11 +157,11 @@ Example using `v1.9.2`:
144
157
145
158
```bash
146
159
git add .
147
-
git commit -m "Bump version to v1.9.2"
160
+
git commit -m "chore: bump version to v1.9.2"
148
161
git push --set-upstream origin release-v1.9.2
149
162
```
150
163
151
164
5. Open and merge the PR into `master`.
152
165
6. Locally, switch back to `master` and pull the changes: `git switch master && git pull`
153
-
7. Create a git tag with the version: `git tag 1.9.2`
166
+
7. Create a git tag with the version: `git tag -a 1.9.2 -m "1.9.2"`
154
167
8. Push the tag: `git push --tags`. <br> You're all set! [This GitHub action](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/.github/workflows/release.yml) should pick it up, create a release, publish it, and update the live documentation.
0 commit comments