Skip to content

Commit 79682b9

Browse files
authored
Update contributing guidelines (#14)
1 parent 57f8625 commit 79682b9

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,43 @@ The above command will guide you through a couple of questions and will auto-gen
2020

2121
* your project directory with Dockerfiles
2222
* an entry in the main README.md
23-
* GitHub action pipelines.
23+
* GitHub action pipelines
24+
* GitHub code ownership
2425

2526
Once this is done, you can start refining your Dockerfiles, update your project README.md, create according tests if needed and PR it for initial review.
2627

2728

29+
## How do I build my own flavour locally?
30+
31+
If you want to test your build locally do so as follows:
32+
```
33+
# Defaults to linux/amd64
34+
make build FLAVOUR=<flavour-name> VERSION=<php-version>
35+
36+
# Explicitly build linux/arm64
37+
make build FLAVOUR=<flavour-name> VERSION=<php-version> ARCH=linux/arm64
38+
```
39+
40+
2841
## Becoming a maintainer
2942

30-
As a maintainer, you will need create a flavour for PHP 5.3 - PHP 8.2 for the `amd64` and `arm64` architecture.
43+
As a maintainer, you must create a working flavour for all PHP versions (PHP 5.3 to PHP 8.2) and for both architectures (`amd64` and `arm64`).
3144

3245
### Benefits
3346

3447
If you plan on adding your own flavoured images to this repository, you will gain the following benefits:
3548

3649
* namespaced flavour
3750
* your customized images
38-
* automatic nightly builds for always up-to-date images
51+
* automatic nightly builds for always up-to-date images pullable from [Dockerhub](https://hub.docker.com/r/devilbox/php-fpm-community)
52+
* useable with the [Devilbox](https://github.com/cytopia/devilbox)
3953

4054
### Responsibilities
4155

42-
By doing so, you will also have to take the continuous responsible to:
56+
By doing so, you will also have to take the continuous responsibility to:
4357

4458
* be the GitHub code owner of your flavour
45-
* ensure your Docker image builds pass
59+
* ensure the builds of your Docker images pass
4660
* work on reported issues on your flavour
4761
* ensure tests exist for anything specific you add to your flavour
4862
* continuously groom your project and review assigned pull requests
@@ -58,7 +72,8 @@ It will basically become your project.
5872
# For the following to work, you must have built all images locally.
5973

6074
FLAVOUR=devilbox
75+
ARCH=linux/amd64
6176
for i in 5.3 5.4 5.5 5.6 7.0 7.1 7.2 7.3 7.4 8.0 8.1 8.2; do \
62-
./tests/bin/gen-readme.sh devilbox/php-fpm-community linux/amd64 ${i}-${FLAVOUR} ${FLAVOUR} ${i}; \
77+
./tests/bin/gen-readme.sh devilbox/php-fpm-community ${ARCH} ${i}-${FLAVOUR} ${FLAVOUR} ${i}; \
6378
done
6479
```

0 commit comments

Comments
 (0)