Skip to content

Commit 9c8ce88

Browse files
authored
docs: review of Development Workflow.md (#3326)
1 parent d974906 commit 9c8ce88

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

docs/dev/Development Workflow.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# General development workflow
1+
# General Development Workflow
22
This document aims to explain the steps component developers would have to perform
33
on daily basis from forking the project to merging a change, emphasising on the Github workflow.
44

@@ -13,38 +13,38 @@ See how to clone a repo [here](https://docs.github.com/en/github/creating-clonin
1313

1414
## 3. Run the project
1515

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**).
1919

2020

21-
*3.1.* Install all dependencies
21+
*3.1.* Install all dependencies.
2222
```sh
2323
yarn
2424
```
2525

26-
*3.2.* Build and serve the project
26+
*3.2.* Build and serve the project.
2727
```sh
2828
yarn start
2929
```
3030
Once the project is served, you can explore the components
3131
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.
3535

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.
3737

3838
*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.*
3939

4040
## 4. Develop
4141

42-
*4.1.* Read the dedicated tutorials for component developers
42+
*4.1.* Read the dedicated tutorials for component developers:
4343

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).
4848

4949
*4.2.* Create a local branch within your fork and work with it as usual.
5050

@@ -61,7 +61,7 @@ $ cd packages/main
6161
$ yarn test test/specs/Button.spec.js
6262
```
6363

64-
## 5. Open Pull Request (PR) from fork
64+
## 5. Open pull request (PR) from fork
6565

6666
You can open a pull request to the upstream repository from any branch or commit in your fork.
6767
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.
7272

7373
*5.2.* Compare the master branch of the upstream with a branch from your fork.
7474

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).*
7676

7777
*5.3.* Once the PR is created you would have to accept a Developer Certificate of Origin (DCO).
7878
Just follow the link posted in the PR by the CLA assistant.
7979

80-
*Note: This is required only for you first PR.*
80+
*Note: This is required only for your first PR.*
8181

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,
8383
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".
8585

8686
*5.5.* Wait for our code review and approval.
8787
After the PR is approved, the UI5 Web Components team will merge the change into the master.
8888

8989

90-
## 6. Update Pull Request, created from a fork
90+
## 6. Update pull request, created from a fork
9191

9292
You often would need to update your pull request, especially when you need to address review comments.
9393
To update your pull request, you have to push commits to the branch, that the pull request is based on
9494
and the changes will be reflected in the pull request.
9595

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.*
9797

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).*
9999

100100
## 7. Sync the fork
101101

@@ -115,17 +115,17 @@ Commits to master will be stored in a local branch, upstream/master.
115115
$ git fetch upstream
116116
```
117117

118-
*7.3.*. Check out your fork's local master branch.
118+
*7.3.* Check out your fork's local master branch.
119119

120120
```sh
121121
$ git checkout master
122122
```
123123

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.
125125
This brings your fork's master branch into sync with the upstream repository, without losing your local changes.
126126

127127
```sh
128128
$ git merge upstream/master
129129
```
130130

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

Comments
 (0)