Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TASK: Add docs for contribution getting started #3798

Merged
merged 2 commits into from
Sep 30, 2024
Merged

TASK: Add docs for contribution getting started #3798

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b17a63
TASK: Add docs for contribution getting started
JamesAlias Jun 1, 2024
5b6b3c7
TASK: Adds code-style
markusguenther Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ And on Packagist available via: `neos/neos-ui`

### Updating

```
```bash
composer update neos/neos-ui
```

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

```
```bash
composer require neos/neos-ui-compiled:8.3.x-dev neos/neos-ui:8.3.x-dev
```

## Contributing

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

To start developing the Neos Ui you will need a running Neos instance locally.
You can use
* one of your own, local Neos 8.3 instances,
* create a new one with `composer create-project neos/neos-base-distribution neos-ui-development-instance`,
* or use the docker compose setup in this repository (see instructions below).

### Setup Source Files and Git
To install the source files and setup git, run:

```bash
composer require neos/neos-ui-compiled:8.3.x-dev neos/neos-ui:8.3.x-dev --prefer-source
```

This will sync the git repository of Neos Ui into `Packages/Application/Neos.Neos.Ui` (this might take a while).
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`).

Run `make setup`. To check what commands are executed have a look at the `Makefile` in the root of this repository.

### on Windows

1) Ensure you have the relevant version installed (see above).
Expand Down
Loading