mirror_php/LinkAce
1
0
Fork 0
mirror of https://github.com/Kovah/LinkAce.git synced 2025-01-17 05:08:21 +01:00
Code Issues Releases Wiki Activity

Update the contribution guide

Browse Source
This commit is contained in:
Kovah 2024-07-17 10:31:47 +02:00
parent 5a23ca931b
commit d7d00a877d
No known key found for this signature in database
GPG Key ID: AAAA031BA9830D7B
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
CONTRIBUTING.md
View File

@ -1,36 +1,39 @@
# :construction: Contribution
If you want to contribute to the project please open a [ticket](https://github.com/Kovah/LinkAce/issues) first and
describe what you want to do or what your idea is. Maybe there already is an existing ticket for your or a very similar
If you want to contribute to the project please open an [issue](https://github.com/Kovah/LinkAce/issues) first and
describe what you want to do or what your idea is. Maybe there already is an existing issue for your or a very similar
topic.
I may decline contributions for features that may not fit into the application, so please make sure to talk to me before
starting to code.
## Contribution Guidelines
* Always use the `dev` branch to work on the application. The dev branch will contain the latest version of the app
while the `main` branch contains the stable version (which may be outdated in terms of development).
* Consider using a separate branch if you are working on a larger feature.
* LinkAce uses two primary branches for the different major versions:
* `1.x`
* `2.x`
* Those two branches hold the latest nightly (i.e. possibly unstable) code for the respective version. The latest stable
version is accessible through the releases section and the corresponding tag.
* Use the appropriate branch as a starting point for your contribution. Then open a pull request with your changes.
* Reference the issue number in your commits please.
* When opening a pull request, link to your ticket and describe what you did to solve the problem.
* When opening a pull request, link to your issue and describe what you did to solve the problem.
---
## Development
### Minimum Requirements
* [Docker](https://www.docker.com/products/docker-desktop)/[Podman](https://podman.io/docs/installation) _or_ a [currently-supported PHP version](https://www.php.net/supported-versions.php)
* For Podman, you also need to `apt`, `dnf`, or otherwise install [`podman-compose`](https://github.com/containers/podman-compose)
* [Node](https://nodejs.org/en/) (16 LTS)
* [Node](https://nodejs.org/en/) (20 LTS)
### 1. Basic Setup
The following steps assume that you are using Docker or Podman for development, which I highly encourage. If you use other ways to work with PHP projects you must adapt the commands to your system. If you want to use Podman, simply replace the word `docker` with `podman` in each command. Clone the repository to your machine and run the following commands to start the Docker container system:
The following steps assume that you are using Docker or Podman for development, which I highly encourage. If you use
other ways to work with PHP projects you must adapt the commands to your system. If you want to use Podman, simply
replace the word `docker` with `podman` in each command. Clone the repository to your machine and run the following
commands to start the Docker container system:
```bash
cp .env.docker .env
@ -45,7 +48,8 @@ docker compose exec -it php composer install
docker compose exec -it php php artisan key:generate
```
Last step: compile all assets. Node 16 LTS is the minimum version required and recommended to use. You may use either NPM or Yarn for installing the asset dependencies.
Last step: compile all assets. Node 16 LTS is the minimum version required and recommended to use. You may use either
NPM or Yarn for installing the asset dependencies.
```bash
npm install
@ -55,7 +59,8 @@ npm run dev
#### 2. Working with the Artisan command line
I recommend using the Artisan command line tool in the PHP container only, to make sure that the same environment is used. To do so, use the following example command:
I recommend using the Artisan command line tool in the PHP container only, to make sure that the same environment is
used. To do so, use the following example command:
```bash
docker compose exec -it php php artisan migrate
@ -69,7 +74,6 @@ Currently, you can do this by using the command line:
docker compose exec -it php php artisan registeruser [user name] [user email]
```
## Tests
You can run existing tests with the following command:
@ -79,10 +83,13 @@ docker compose exec -it php composer run lint
docker compose exec -it php composer run test
```
---
## LinkAce Base Docker image
The Base image for LinkAce contains several packages and PHP extensions needed by LinkAce. It shortens the build time of the release images. This step is not needed by any developer working on LinkAce and is just a documentation for maintainers.
The Base image for LinkAce contains several packages and PHP extensions needed by LinkAce. It shortens the build time of
the release images. This step is not needed by any developer working on LinkAce and is just a documentation for
maintainers.
```bash
docker buildx build --push --platform "linux/amd64,linux/arm64,linux/arm/v7" -t linkace/base-image:php-8.3-alpine -f resources/docker/dockerfiles/release-base.Dockerfile .