mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-01 19:50:32 +08:00
8d5d20480a
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.
105 lines
5.2 KiB
Markdown
105 lines
5.2 KiB
Markdown
# Contribute
|
|
|
|
## Introduction
|
|
|
|
First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! 😊
|
|
|
|
We welcome any type of contribution, not only code. You can help with
|
|
|
|
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
|
|
- **Marketing**: writing blog posts, howto's, printing stickers, ...
|
|
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
|
|
- **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
|
|
- **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify).
|
|
|
|
## Your First Contribution
|
|
|
|
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).
|
|
|
|
## Online one-click setup for Contributing
|
|
|
|
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
|
|
|
|
- clone the docsify repo.
|
|
- install the dependencies.
|
|
- start `npm run dev`.
|
|
|
|
```bash
|
|
npm install && npm run dev
|
|
```
|
|
|
|
So that you can start straight away.
|
|
|
|
[](https://gitpod.io/#https://github.com/docsifyjs/docsify)
|
|
|
|
- Fork it!
|
|
- Create your feature branch: `git checkout -b my-new-feature`
|
|
- Commit your changes: `git add . && git commit -m 'Add some feature'`
|
|
- Push to the branch: `git push origin my-new-feature`
|
|
- Submit a pull request
|
|
|
|
## Submitting code
|
|
|
|
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.
|
|
|
|
## Testing
|
|
|
|
Ensure that things work by running:
|
|
|
|
```sh
|
|
npm test
|
|
```
|
|
|
|
## Test Snapshots
|
|
|
|
If a snapshot fails, or to add new snapshots, run:
|
|
|
|
```sh
|
|
npx jest --updateSnapshot
|
|
```
|
|
|
|
## Code review process
|
|
|
|
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.
|
|
It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
|
|
|
|
## Financial contributions
|
|
|
|
We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify).
|
|
Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
|
|
|
|
## Questions
|
|
|
|
If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
|
|
You can also reach us at hello@docsify.opencollective.com.
|
|
|
|
## Credits
|
|
|
|
### Contributors
|
|
|
|
Thank you to all the people who have already contributed to docsify!
|
|
<a href="graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
|
|
|
|
### Backers
|
|
|
|
Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#backer)]
|
|
|
|
<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
|
|
|
|
### Sponsors
|
|
|
|
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))
|
|
|
|
<a href="https://opencollective.com/docsify/sponsor/0/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/1/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/2/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/3/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/4/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/5/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/6/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/7/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/8/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/docsify/sponsor/9/website" target="_blank"><img src="https://opencollective.com/docsify/sponsor/9/avatar.svg"></a>
|
|
|
|
<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->
|