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
Copy file name to clipboardExpand all lines: docs/dev/Development Workflow.md
+26-26
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# General development workflow
1
+
# General Development Workflow
2
2
This document aims to explain the steps component developers would have to perform
3
3
on daily basis from forking the project to merging a change, emphasising on the Github workflow.
4
4
@@ -13,38 +13,38 @@ See how to clone a repo [here](https://docs.github.com/en/github/creating-clonin
13
13
14
14
## 3. Run the project
15
15
16
-
*3.0.* Make sure you have the following prerequisites installed
17
-
-[Yarn](https://yarnpkg.com/en)
18
-
-[Node.js](https://nodejs.org/) (**version 14 or higher**)
16
+
*3.0.* Make sure you have the following prerequisites installed:
17
+
-[Yarn](https://yarnpkg.com/en);
18
+
-[Node.js](https://nodejs.org/) (**version 14 or higher**).
19
19
20
20
21
-
*3.1.* Install all dependencies
21
+
*3.1.* Install all dependencies.
22
22
```sh
23
23
yarn
24
24
```
25
25
26
-
*3.2.* Build and serve the project
26
+
*3.2.* Build and serve the project.
27
27
```sh
28
28
yarn start
29
29
```
30
30
Once the project is served, you can explore the components
31
31
on:
32
-
-http://localhost:8080/test-resources/pages/ for the `main` package
33
-
-http://localhost:8081/test-resources/pages/ for the `fiori` package
34
-
-http://localhost:9191/test-resources/pages/ for the `base` package
32
+
-http://localhost:8080/test-resources/pages/ for the `main` package;
33
+
-http://localhost:8081/test-resources/pages/ for the `fiori` package;
34
+
-http://localhost:9191/test-resources/pages/ for the `base` package.
35
35
36
-
The server will reload the pages, whenever you make changes in the code.
36
+
The server will reload the pages whenever you make changes in the code.
37
37
38
38
*Note: If these ports are unavailable to be opened, then the pages will be served on the next available ports. See the console output for the available URLs.*
39
39
40
40
## 4. Develop
41
41
42
-
*4.1.* Read the dedicated tutorials for component developers
42
+
*4.1.* Read the dedicated tutorials for component developers:
43
43
44
-
-[Development Conventions and Guidelines](../Guidelines.md)
45
-
-[Developing UI5 Web Components](./Developing Web Components.md)
46
-
-[Testing UI5 Web Components](./Testing Web Components.md)
47
-
-[What is Metadata?](./Metadata.md)
44
+
-[Development Conventions and Guidelines](../Guidelines.md);
45
+
-[Developing UI5 Web Components](./Developing Web Components.md);
46
+
-[Testing UI5 Web Components](./Testing Web Components.md);
47
+
-[Metadata](./Metadata.md).
48
48
49
49
*4.2.* Create a local branch within your fork and work with it as usual.
50
50
@@ -61,7 +61,7 @@ $ cd packages/main
61
61
$ yarn test test/specs/Button.spec.js
62
62
```
63
63
64
-
## 5. Open Pull Request (PR) from fork
64
+
## 5. Open pull request (PR) from fork
65
65
66
66
You can open a pull request to the upstream repository from any branch or commit in your fork.
67
67
We recommend that you make changes in a topic branch (not in your local master), so that you can push followup commits if you receive feedback on your pull request.
@@ -72,30 +72,30 @@ You can open a pull request from the Github UI.
72
72
73
73
*5.2.* Compare the master branch of the upstream with a branch from your fork.
74
74
75
-
*Note: The full guide to open PR from fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).*
75
+
*Note: The full guide on how to open PR from fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).*
76
76
77
77
*5.3.* Once the PR is created you would have to accept a Developer Certificate of Origin (DCO).
78
78
Just follow the link posted in the PR by the CLA assistant.
79
79
80
-
*Note: This is required only for you first PR.*
80
+
*Note: This is required only for your first PR.*
81
81
82
-
*5.4.* Immediately after the PR is created a central build process starts to verify the change,
82
+
*5.4.* Immediately after the PR is created, a central build process starts to verify the change,
83
83
building the project and running all tests.
84
-
In case you are interested in the build output, you can follow the link at the bottom of the PR page, called "continuous-integration/travis-ci/pr"
84
+
In case you are interested in the build output, you can follow the link at the bottom of the PR page, called "continuous-integration/travis-ci/pr".
85
85
86
86
*5.5.* Wait for our code review and approval.
87
87
After the PR is approved, the UI5 Web Components team will merge the change into the master.
88
88
89
89
90
-
## 6. Update Pull Request, created from a fork
90
+
## 6. Update pull request, created from a fork
91
91
92
92
You often would need to update your pull request, especially when you need to address review comments.
93
93
To update your pull request, you have to push commits to the branch, that the pull request is based on
94
94
and the changes will be reflected in the pull request.
95
95
96
-
*Note: We recommend syncing your fork, before pushing commits to resolve merge conflicts beforehand.*
96
+
*Note: We recommend syncing your fork before pushing commits to resolve merge conflicts beforehand.*
97
97
98
-
*Note: The full guide to update PR can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork).*
98
+
*Note: The full guide on how to update PR can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork).*
99
99
100
100
## 7. Sync the fork
101
101
@@ -115,17 +115,17 @@ Commits to master will be stored in a local branch, upstream/master.
115
115
$ git fetch upstream
116
116
```
117
117
118
-
*7.3.*. Check out your fork's local master branch.
118
+
*7.3.* Check out your fork's local master branch.
119
119
120
120
```sh
121
121
$ git checkout master
122
122
```
123
123
124
-
*7.4.*. Merge the changes from upstream/master into your local master branch.
124
+
*7.4.* Merge the changes from upstream/master into your local master branch.
125
125
This brings your fork's master branch into sync with the upstream repository, without losing your local changes.
126
126
127
127
```sh
128
128
$ git merge upstream/master
129
129
```
130
130
131
-
*Note: The full guide to sync a fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).*
131
+
*Note: The full guide on how to sync a fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).*
0 commit comments