You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Help us keep UI Kitten open and inclusive. Please read and follow our [Code of Conduct][coc].
14
+
## Code of Conduct
17
15
18
-
## <aname="question"></a> Got a Question or Problem?
16
+
Help us keep UI Kitten open and inclusive. Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
19
17
20
-
Please do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow][stackoverflow] where the questions should be tagged with tag `react-native-ui-kitten`.
18
+
## Got a Question or Problem?
19
+
20
+
Please do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/search?q=ui-kitten) where the questions should be tagged with tag `ui-kitten`.
21
21
22
22
StackOverflow is a much better place to ask questions since:
23
23
@@ -27,54 +27,62 @@ StackOverflow is a much better place to ask questions since:
27
27
28
28
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.
29
29
30
+
## Found an Issue?
30
31
31
-
## <aname="issue"></a> Found an Issue?
32
-
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.
32
+
If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](#submitting-an-issue) to our [GitHub Repository](https://github.com/akveo/react-native-ui-kitten/issues/new/choose). 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.
33
33
34
34
Please follow this simple checklist before submitting:
35
35
36
-
* If you have a question about using UI Kitten, please ask on the [StackOverflow][stackoverflow].
36
+
* If you have a question about using UI Kitten, please ask on the [StackOverflow](https://stackoverflow.com/search?q=ui-kitten).
37
37
38
38
* It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Although we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely time-consuming and simply not sustainable.
39
39
40
40
* The issue list of this repository is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.
41
41
42
42
* Issues with no clear steps to reproduce will not be triaged. If an issue is labeled with "needs info" and receives no further replies from the author of the issue for more than 5 days, it will be closed.
43
43
44
-
* If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported][issues]. You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
44
+
* If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported](https://github.com/akveo/react-native-ui-kitten/issues). You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.
45
+
46
+
* Next, [create a new issue](#submitting-an-issue) that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue.
45
47
46
-
* Next, [create a new issue](#submit-issue) that thoroughly explains the problem. Please fill out the populated issue form before submitting the issue.
48
+
## Want a Feature?
47
49
48
-
## <aname="feature"></a> Want a Feature?
49
-
You can *request* a new feature by [submitting an issue](#submit-issue) to our [GitHub Repository][github]. If you would like to *implement* a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
50
+
You can *request* a new feature by [submitting an issue](https://github.com/akveo/react-native-ui-kitten/issues/new/choose) to our GitHub Repository. If you would like to *implement* a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
51
+
52
+
***Small Features** can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request-pr).
50
53
51
54
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
52
55
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
53
56
and help you to craft the change so that it is successfully accepted into the project.
54
-
***Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
55
-
56
-
### <aname="submit-issue"></a> Submitting an Issue Before you submit an issue, search the archive, maybe your question was already answered.
57
57
58
-
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.
58
+
### Submitting an Issue
59
+
60
+
Before you submit an issue, search the archive, maybe your question was already answered.
59
61
60
-
You can file new issuesby providing the information [here][new_issue].
62
+
If your issue appears to be a bug and hasn't been reported, [open a new issue](https://github.com/akveo/react-native-ui-kitten/issues/new/choose). 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.
61
63
64
+
### Submitting a Pull Request (PR)
62
65
63
-
### <aname="submit-pr"></a> Submitting a Pull Request (PR)
64
66
Before you submit your Pull Request (PR) consider the following guidelines:
65
67
66
-
* Search [GitHub][pulls] for an open or closed PR
68
+
* Search [GitHub](https://github.com/akveo/react-native-ui-kitten/pulls) for an open or closed PR
67
69
that relates to your submission. You don't want to duplicate effort.
70
+
68
71
* Make your changes in a new git branch:
69
72
70
-
```shell
71
-
git checkout -b my-fix-branch master
72
-
```
73
-
* Read the [developer documentation][dev-doc].
73
+
```shell
74
+
git checkout -b fix/my-fix-branch master
75
+
```
76
+
77
+
* Read the [developer documentation](./DEV_DOCS.md).
78
+
74
79
* Create your patch, **including appropriate test cases**.
75
-
* Follow our [Coding Rules](#rules).
80
+
81
+
* Follow our [Coding Rules](#coding-rules).
82
+
76
83
* Test your changes.
77
-
* Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). Adherence to these conventions is necessary because release notes are automatically generated from these messages.
84
+
85
+
* Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit-message-guidelines). Adherence to these conventions is necessary because release notes are automatically generated from these messages.
78
86
79
87
```shell
80
88
git commit -a
@@ -88,8 +96,11 @@ Before you submit your Pull Request (PR) consider the following guidelines:
88
96
```
89
97
90
98
* In GitHub, send a pull request to `master`.
99
+
91
100
* If we suggest changes then:
101
+
92
102
* Make the required updates.
103
+
93
104
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
94
105
95
106
```shell
@@ -129,42 +140,18 @@ from the main (upstream) repository:
129
140
git pull --ff upstream master
130
141
```
131
142
132
-
## <a name="rules"></a> Coding Rules
143
+
## Coding Rules
144
+
133
145
To ensure consistency throughout the source code, keep these rules in mind as you are working:
134
146
135
147
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
136
148
* All public API methods **must be documented** following JsDoc notation.
137
149
138
-
## <a name="run"></a> Run Demo Application
150
+
## Debugging your changes
139
151
140
-
UI Kitten has [Demo Application](https://github.com/akveo/kittenTricks) which allows you to debug quickly your changes.
141
-
To run it you should:
142
-
* Clone UI Kitten project
143
-
* Clone Kitten Tricks project
144
-
* Clone Eva Design System project
145
-
* Go to project root directory:
146
-
```
147
-
cd ./path-to/react-native-ui-kitten
148
-
```
149
-
* Install dependencies:
150
-
```
151
-
yarn
152
-
```
153
-
* That's it! You're ready to run:
154
-
```
155
-
yarn demo start:dev
156
-
```
157
-
* Now you will be prompted by CLI to select the device you'd like to run.
158
-
Just follow the CLI instructions. Normally you should hit `a` or `i` button
159
-
to make Android or iOS device running.
160
-
161
-
## <a name="debug"></a> Debugging your changes
162
-
163
-
If you're done with running Kitten Tricks on Android emulator or iOS simulator,
164
-
you can observe all the changes you do inside [components module](src/components)
165
-
on the device you have started. That's where hot/live reload takes place.
152
+
See [developer documentation](./DEV_DOCS.md#start-a-demo-application) for this step.
0 commit comments