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
refactor: delete the experimental and incomplete SSR feature
BREAKING: SSR removed
Anyone depending on SSR will need to stay on an old Docsify version for
now, move forward without SSR, or maintain SSR against a fork of updated
Docsify. We have ideas on a better way to implement SSR, but these ideas
have not been implemented yet.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+41-4Lines changed: 41 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,8 @@
4
4
5
5
First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! 😊
6
6
7
-
We welcome any type of contribution, not only code. You can help with
7
+
We welcome any type of contribution, not only code. You can help with
8
+
8
9
-**QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
9
10
-**Marketing**: writing blog posts, howto's, printing stickers, ...
10
11
-**Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
@@ -13,12 +14,50 @@ We welcome any type of contribution, not only code. You can help with
13
14
14
15
## Your First Contribution
15
16
16
-
Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
17
+
Working on your first Pull Request ever? You can learn how from this _free_ series, [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
18
+
19
+
## Online one-click setup for Contributing
20
+
21
+
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
22
+
23
+
- clone the docsify repo.
24
+
- install the dependencies.
25
+
- start `npm run dev`.
26
+
27
+
```bash
28
+
npm install && npm run dev
29
+
```
30
+
31
+
So that you can start straight away.
32
+
33
+
[](https://gitpod.io/#https://github.com/docsifyjs/docsify)
34
+
35
+
- Fork it!
36
+
- Create your feature branch: `git checkout -b my-new-feature`
37
+
- Commit your changes: `git add . && git commit -m 'Add some feature'`
38
+
- Push to the branch: `git push origin my-new-feature`
39
+
- Submit a pull request
17
40
18
41
## Submitting code
19
42
20
43
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
21
44
45
+
## Testing
46
+
47
+
Ensure that things work by running:
48
+
49
+
```sh
50
+
npm test
51
+
```
52
+
53
+
## Test Snapshots
54
+
55
+
If a snapshot fails, or to add new snapshots, run:
56
+
57
+
```sh
58
+
npx jest --updateSnapshot
59
+
```
60
+
22
61
## Code review process
23
62
24
63
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
0 commit comments