Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
wuweiweiwu authored and pedronauck committed Sep 6, 2018
1 parent 2ce5846 commit 4cbae28
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Contributions, issues and feature requests are very welcome. If you are using th

## Guidelines

If you will develop some pull request, it's very important follow these basic rules:
If you are planning to submit a pull request, it's very important follow these basic rules:

### Commit messages

Expand All @@ -17,7 +17,7 @@ Commit messages should follow the [commit message convention](https://convention
- Work in the **src** folder of respective package and **DO NOT** checkin dist in the commits.
- It's OK - and a very nice thing - to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

### If adding new feature:
### If adding a new feature:

- Make sure that [all examples](https://github.com/pedronauck/docz/tree/master/examples) are running as expected
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
Expand Down Expand Up @@ -63,7 +63,7 @@ There's a lot of [packages](https://github.com/pedronauck/docz/tree/master/packa
- This is the core of docz. All build algorithms, server process and parses belongs to here.
- If you break this package, probably you'll break all packages! Please, be carefull.
- All cli commands are built here and imported on `docz` package using `./bin` script.
- Do not create scripts that's running on browser here, just node scripts.
- Do not create scripts that's running on browser here, only node scripts.

#### **[docz](https://github.com/pedronauck/docz/tree/master/packages/docz)**
- Main and top level package.
Expand All @@ -74,16 +74,16 @@ There's a lot of [packages](https://github.com/pedronauck/docz/tree/master/packa
### Watching projects

To speed up your develop process:
- Split your terminal openning the packages that you need to develop and running `yarn dev` in each window.
- After that, use any of this splitted window to run `yarn dev` in some [example](https://github.com/pedronauck/docz/tree/master/examples) to run it, like that:
- Split your terminal and open each package directory in a separate window.
- Run `yarn dev` in each window to run the watch tasks. For example, in this [examples](https://github.com/pedronauck/docz/tree/master/examples) directory.

![](https://cdn-std.dprcdn.net/files/acc_649651/MdH4FL)

Now you're watching `docz`, `docz-core` and `docz-theme-default` and running `docz-example-basic`. So, any modificationmade on any package will reflect on basic example on the fly!
In the above example you're watching `docz`, `docz-core` and `docz-theme-default` and also running `docz-example-basic`. So any modifications made to any of those packages will reflect in basic example on the fly!

### Creating plugins

If has some plugin that you want to create, please contact-me before to talk about the possibility to make this plugin official!
If there are some plugin that you want to create, please contact me before to talk about the possibility to make this plugin official!

## Contributors

Expand Down

0 comments on commit 4cbae28

Please sign in to comment.