Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

96 lines (66 loc) · 3.29 KB
Raw

🚧 Contribution

If you want to contribute to the project please open an issue 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

  • 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 issue and describe what you did to solve the problem.

Development

Minimum Requirements

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:

cp .env.docker .env
docker compose up -d --build

Now, install all dependencies from inside the PHP container:

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.

npm install

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:

docker compose exec -it php php artisan migrate

3. Registering a new user

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:

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.

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 .