Skip to content

Commit 9754d55

Browse files
TASK: Add docs for contribution getting started (#3798)
* TASK: Add docs for contribution getting started * TASK: Adds code-style --------- Co-authored-by: Markus Günther <info@unikka.de>
1 parent cb36295 commit 9754d55

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ And on Packagist available via: `neos/neos-ui`
4848

4949
### Updating
5050

51-
```
51+
```bash
5252
composer update neos/neos-ui
5353
```
5454

@@ -58,14 +58,32 @@ For trying out the new UI, we recommend you to run the regularily released beta
5858
However, if you want to stay on bleeding-edge, or want to help out developing, you'll
5959
need the `8.3.x-dev` release. You can install the latest release using:
6060

61-
```
61+
```bash
6262
composer require neos/neos-ui-compiled:8.3.x-dev neos/neos-ui:8.3.x-dev
6363
```
6464

6565
## Contributing
6666

6767
Please follow the respective guides for contributing on OSX and on Linux.
6868

69+
To start developing the Neos Ui you will need a running Neos instance locally.
70+
You can use
71+
* one of your own, local Neos 8.3 instances,
72+
* create a new one with `composer create-project neos/neos-base-distribution neos-ui-development-instance`,
73+
* or use the docker compose setup in this repository (see instructions below).
74+
75+
### Setup Source Files and Git
76+
To install the source files and setup git, run:
77+
78+
```bash
79+
composer require neos/neos-ui-compiled:8.3.x-dev neos/neos-ui:8.3.x-dev --prefer-source
80+
```
81+
82+
This will sync the git repository of Neos Ui into `Packages/Application/Neos.Neos.Ui` (this might take a while).
83+
To push your changes to GitHub you need to fork the Neos Ui and change the git remote to your fork (check with `git remove -v`).
84+
85+
Run `make setup`. To check what commands are executed have a look at the `Makefile` in the root of this repository.
86+
6987
### on Windows
7088

7189
1) Ensure you have the relevant version installed (see above).

0 commit comments

Comments
 (0)