Skip to content

Commit

Permalink
docs(common): fix DEV_DOCS, CODE_OF_CONDUCT, CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
32penkin authored and artyorsh committed Jun 10, 2019
1 parent e914362 commit 870d57d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 28 deletions.
6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
As contributors and maintainers of the react-native-ui-kitten project, and in the interest of fostering an open and welcoming community,
we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender,
We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender,
gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality or anything else.

Examples of unacceptable behavior by participants include:
Expand All @@ -22,6 +22,6 @@ Project maintainers who do not follow or enforce the Code of Conduct may be perm

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
Instances of abusive, harassing or otherwise, unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to react-native-ui-kitten

We would love for you to contribute to react-native-ui-kitten and help make it ever better together! :rocket:
We would love for you to contribute to react-native-ui-kitten and help make it even better together! :rocket:

- [Code of Conduct](#coc)
- [Question or Problem?](#question)
Expand All @@ -22,14 +22,14 @@ Please do not open issues for general support questions as we want to keep GitHu
StackOverflow is a much better place to ask questions since:

- there are thousands of people willing to help on StackOverflow
- questions and answers stay available for public viewing so your question / answer might help someone else
- questions and answers stay available for public viewing so your question/answer might help someone else
- StackOverflow's voting system assures that the best answers are prominently visible.

To save your and our time, we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.


## <a name="issue"></a> Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. Including an issue reproduction is the absolute best way to help the team quickly diagnose the problem. Screenshots and error stack traces are also helpful.
If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. Including an issue, reproduction is the absolute best way to help the team quickly diagnose the problem. Screenshots and error stack traces are also helpful.

Please follow this simple checklist before submitting:

Expand All @@ -55,7 +55,7 @@ and help you to craft the change so that it is successfully accepted into the pr

### <a name="submit-issue"></a> Submitting an Issue Before you submit an issue, search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features by not reporting duplicate issues. Please make sure to fill out the populated issue form before submitting the issue.
If your issue appears to be a bug and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features by not reporting duplicate issues. Please make sure to fill out the populated issue form before submitting the issue.

You can file new issues by providing the information [here][new_issue].

Expand Down Expand Up @@ -137,7 +137,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
## <a name="run"></a> Run playground
React-native-ui-kitten contains playground module which allows you quickly debug your changes.
React-native-ui-kitten contains playground module which allows you to debug quickly your changes.
See the project in [playground directory](src/playground).
To run it you should:
* Clone this repo
Expand All @@ -153,15 +153,15 @@ npm install
```
npm start
```
* Now you will be prompted by CLI to select device you'd like to run.
* Now you will be prompted by CLI to select the 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

If you done with running playground on Android emulator or iOS simulator,
If you're 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.
on the device you have started. That's where hot/live reload takes place.

## <a name="commit"></a> Commit Message Guidelines

Expand All @@ -188,7 +188,7 @@ to read on GitHub as well as in various git tools.

### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of
the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is
the reverted commit. In the body, it should say: `These reverts commit <hash>.`, where the hash is
the SHA of the commit being reverted.

### Type
Expand All @@ -199,16 +199,16 @@ Must be one of the following:
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
semi-colons, etc)
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **refactor**: A code change that neither fixes a bug or adds a feature
* **perf**: A code change that improves performance
* **test**: Adding missing tests or correcting existing tests
* **build**: Changes that affect the build system, CI configuration or external dependencies
(example scopes: gulp, broccoli, npm)
* **chore**: Other changes that don't modify `src` or `test` files
* **relese**: Release version commit
* **release**: Release version commit
### Scope
* For [framework's ui module](src/framework/ui) the scope should be name of component that was affected:
* For [framework's ui module](src/framework/ui) the scope should be the name of the component that was affected:
```
style(button): add styles for pressed state
```
Expand All @@ -218,10 +218,10 @@ build(playground): react-navigation integration
```

### Subject
The subject contains succinct description of the change:
The subject contains a succinct description of the change:

* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize first letter
* don't capitalize the first letter
* no dot (.) at the end
### Body
Expand All @@ -232,7 +232,7 @@ The body should include the motivation for the change and contrast this with pre
Optional. The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
**Breaking Changes** should start with the word `BREAKING CHANGE:` with space or two newlines.
The rest of the commit message is then used for this.
[coc]: CODE_OF_CONDUCT.md
Expand Down
18 changes: 8 additions & 10 deletions DEV_DOCS.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# Release checklist:

1. Create a new release branch with template `release-vX.X.X`
1. Create a new release branch with template `release/vX.X.X`
2. Update package version in package.json
3. Run and test [Playground](src/playground) ([guide](CONTRIBUTING.md#run))
3. Run tests: `npm run release:validate`
4. Run [docs](docs)
5. Generate [changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)
5. Generate changelog: `npm run version:changelog`
6. Fix/expand changelog manually
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 [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)
10. Run tests: `npm run release:validate`
11. Assemble build: `npm run release:prepare`
12. Publish the package to npm: `npm run release`
13. 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](https://akveo.slack.com/messages/C6AGWCWMU/)
15. Create release on GitHub for the tag

0 comments on commit 870d57d

Please sign in to comment.