Skip to content

Commit

Permalink
fix(docs): update dev and contributing guides (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
artyorsh authored and malashkevich committed Nov 9, 2018
1 parent c14a5f1 commit b0e1285
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 14 deletions.
38 changes: 34 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ We would love for you to contribute to react-native-ui-kitten and help make it e
- [Feature Requests](#feature)
- [Submission Guidelines](#submit-pr)
- [Coding Rules](#rules)
- [Run Playground](#run)
- [Debugging your changes](#debug)
- [Commit Message Guidelines](#commit)

Expand Down Expand Up @@ -134,10 +135,33 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
* All public API methods **must be documented** following JsDoc notation.
## <a name="run"></a> Run playground
React-native-ui-kitten contains playground module which allows you quickly debug your changes.
See the project in [playground directory](src/playground).
To run it you should:
* Clone this repo
* Go to project root directory:
```
cd ./path-to/react-native-ui-kitten
```
* Install dependencies:
```
npm install
```
* That's it! You're ready to run:
```
npm start
```
* Now you will be prompted by CLI to select device you'd like to run.
Just follow the CLI instructions. Normally you should hit `a` or `i` button
to make Android or iOS device running.

## <a name="debug"></a> Debugging your changes

React-native-ui-kitten contains example project which allows you quickly debug your changes.
See the project in `./example` folder and [guides](example/README.md) to know how we use it.
If you done with running playground on Android emulator or iOS simulator,
you can observe all the changes you do inside [framework](src/framework)
on device you have started. That's where hot/live reload takes place.
## <a name="commit"></a> Commit Message Guidelines
Expand Down Expand Up @@ -184,8 +208,14 @@ Must be one of the following:
* **relese**: Release version commit

### Scope
The scope could be anything specifying place of the commit change. For example
`menu`, `sidebar`, etc.
* For [framework's ui module](src/framework/ui) the scope should be name of component that was affected:
```
style(button): add styles for pressed state
```
* For changes in other modules (like [theme](src/framework/theme) or [playground](src/playground)) the scope should be module name:
```
build(playground): react-navigation integration
```
### Subject
The subject contains succinct description of the change:
Expand Down
20 changes: 10 additions & 10 deletions DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

1. Create a new release branch with template `release-vX.X.X`
2. Update package version in package.json
3. Run and test ExplorerApp
4. Run docs
5. Generate changelog (https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)
3. Run and test [Playground](src/playground) ([guide](CONTRIBUTING.md#run))
4. Run [docs](docs)
5. Generate [changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)
6. Fix/expand changelog manually
7. Update readme.md files if needed
7. Update [readme](README.md) files if needed
8. Push the branch, create PR, approve, merge
9. Switch to master branch and pull changes
10. Run and test ExplorerApp
11. Publish application to expo.io
13. Publish the package to npm
12. Generate public docs (docs:gh-pages)
14. Create and push git tag with template (vX.X.X)
10. Run and test [Playground](src/playground)
11. Publish application to [Expo](https://docs.expo.io/versions/latest/workflow/publishing)
13. Publish the package to [npm](https://docs.npmjs.com/getting-started/publishing-npm-packages)
12. Generate public [docs](docs/DEV_DOCS.md)
14. Create and push [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) with template `(vX.X.X)`
15. Create release on github for the tag
16. Talk to PR to publish updates on social media.
17. Post into #akveo_ad
17. Post into [#akveo_ad](https://akveo.slack.com/messages/C6AGWCWMU/)
Empty file added docs/DEV_DOCS.md
Empty file.

0 comments on commit b0e1285

Please sign in to comment.