3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

misc: update Gitpod description (#2421)

Browse source 
* update the gitpod setup description to be precise.

* add info about Gitpod setup to contributing.md
This commit is contained in:
Nisar Hassan Naqvi 2020-03-17 21:59:09 +05:00 • committed by GitHub
parent 99943a6041
commit 2619a06076
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -91,6 +91,18 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
- For Docusaurus 1 development, run `yarn start:v1`
- For Docusaurus 2 development, run `yarn start`
## Online one-click setup for contributing
You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click it will launch a workspace (for Docusaurus 2) and automatically:
- clone the docusaurus repo.
- install the dependencies.
- run `yarn run start`
So that you can start contributing straight away.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/facebook/docusaurus)
## Pull Requests
### Your First Pull Request

6
README.md
View file

@ -44,12 +44,6 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad
Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.
### Contribute online with a single click
You can use Gitpod (a free, online, VS Code-based IDE) for contributing. It will launch a ready to code workspace (for Docusaurus 2) with all the dependencies installed and the development server running so that you can start contributing straight away.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/facebook/docusaurus)
### Beginner-friendly bugs
To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started.