Skip to content

Commit

Permalink
feat: updating CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nvh95 committed May 6, 2022
1 parent 3397890 commit b148f3e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
12 changes: 10 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@

## Welcome

TODO: Welcome and appreciate contributors. Jest Preview is a community-driven project.
Welcome to CONTRIBUTING zone. If you are reading this, you are probably want to contribute to Open Source projects. That's great! Contributing to an open source project is a great opportunity to learn, sharpen your skills and help others. Luckily, Jest Preview is a free and open source project and we always wecome new contributors. Its mission is to help front end developers' life easier and more enjoyable, also improve the standard of front end applications by encourgaging them to write more high-quality tests, by providng an ability to view the actual UI in Jest in an external browser like Chrome.

Jest Preview aims to be a community-driven project. So we hope to see your contributions to make Jest Preview a favourite library for front end developers when it comes to testing.

## What can I contribute?

- Docs
We appreciated any helps. There are not a thing as small contribution. If you see a typo, send us a PR. If you experience a bug, please open an issue. If you have a suggestion, let us know. Bellow are some ways to contribute to Jest Preview:

- **Submit bugs or issues:**: Software are full of bugs. If you use Jest Preview and find a bug, please open an issue at [Jest Preview's issues](https://github.com/nvh95/jest-preview/issues)
- **Docs**: We have a documentation site at [www.jest-preview.com](https://www.jest-preview.com/docs/getting-started/intro), (draft) it's very easier to contribute to the documentation by using `Edit this page` feature (insert image)
- Fix bugs
- Add new features
- Grammar: not native English speakers.
- Answer questions and issues on GitHub and Discord

If not sure what to contribute, Join Discord

## Claim issue

- See docusaurus's docs: https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#claiming-issues
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Jest Preview comes with [Pre-configured transformation](https://www.jest-preview

## Contributing

We can't wait to see your contributions. See more at [CONTRIBUTING.md](/CONTRIBUTING.md)
We can't wait to see your contributions. See the Contribution Guide at [CONTRIBUTING.md](/CONTRIBUTING.md)

## Contributors ✨

Expand Down
4 changes: 3 additions & 1 deletion website/docs/others/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ sidebar_position: 2

# Contributing

TBD
See Contributing guidelines at [CONTRIBUTING.md](https://github.com/nvh95/jest-preview/blob/main/CONTRIBUTING.md)

<!-- Can we update the build pipeline to copy /CONTRIBUTING.md to this file? So user don't have to navigate back to GitHub to read contributin guideline -->

0 comments on commit b148f3e

Please sign in to comment.