Skip to content

Commit f7abf12

Browse files
add process
1 parent 24f6a9c commit f7abf12

File tree

2 files changed

+77
-25
lines changed

2 files changed

+77
-25
lines changed
Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,61 @@
11
---
22
name: New docker compose request
33
about: Create new docker-compose this project
4-
title: 'complete docker-compose.yml for [appname]'
4+
title: 'Create docker-compose.yml project for [appname]'
55
labels: 'feature'
66
assignees: ''
77
---
88

9-
**What type of your feature request?**
9+
## Describe application with below format
10+
11+
```
12+
# application name
13+
name: "Websoft9"
14+
# URL of the software project's homepage
15+
website_url: "https://www.websoft9.com"
16+
# URL where the full source code of the program can be downloaded
17+
source_code_url: "https://gitlab.com/websoft9/websoft9"
18+
# a brief and concise statementthat presents the main points for this application, shorter than 10 characters
19+
summary: "Open source Application self-hosting platform"
20+
# description of what the software does, shorter than 250 characters, sentence case
21+
description: "GitOps-driven, multi-application hosting for cloud servers and home servers, one-click deployment of 200+ open source apps."
22+
# list of license identifiers, see https://opensource.org/licenses for the full list of licenses
23+
licenses:
24+
- LGPL-3.0
25+
# (optional, true/false, default true) whether this application have Docker image
26+
Docker_image: true
27+
# (optional) link to an interactive demo of the software
28+
demo_url: "https://www.websoft9.com/demo"
29+
```
30+
31+
## Assessment Checklist by repository owner
32+
33+
Before deveopment, repository owner should complete below Assessment:
34+
35+
- [ ] This application have **3** containers
36+
- [ ] official architecture research
37+
- [ ] Complete the Contentful data for
38+
- [ ] Create app project structure from template
39+
40+
41+
## Development Checklist by deveoper
42+
43+
Developer should develop this application's docker compose project at **Websoft9 Console** directly.
1044

1145
- [ ] official architecture research
12-
- [ ] test offcial docker
13-
- [ ] complete standardized expression
14-
- [ ] developer test and running
46+
- [ ] follow [standardized syntax](https://github.com/Websoft9/docker-library/blob/main/docs/code_owner.md)
1547
- [ ] specials and refers at notes.md/.env/docker-compose.yml
16-
- [ ] contentful
17-
- [ ] test at Appstore and nginx proxy testing
18-
- [ ] docs
19-
- [ ] siteurl or baseurl
20-
- [ ] more environments from or configuration file
48+
- [ ] test at Websoft9 Appstore and nginx proxy testing
49+
- [ ] check siteurl or baseurl
50+
- [ ] add official environments reference at .env
2151
- [ ] connetion URI
2252
- [ ] ports
2353
- [ ] credentials environment
2454
- [ ] i18n
25-
- [ ] other
55+
- [ ] commit RP to dev branch
56+
57+
## Production preparation by repository owner
58+
59+
- [ ] system test
60+
- [ ] docs
61+
- [ ] publish to RC release

CONTRIBUTING.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@
22

33
From opening a bug report to creating a pull request: every contribution is appreciated and welcome.
44

5-
If you're planning to implement a new feature or change the docker-library repository, please [create an issue](https://github.com/websoft9/docker-library/issues/new/choose) first. This way we can ensure that your precious work is not in vain.
6-
7-
## Process
5+
If you're planning to implement a new feature or change this repository, please [create an issue](https://github.com/websoft9/docker-library/issues/new/choose) first. This way we can ensure that your precious work is not in vain.
6+
7+
## Quick start for contributing new application
8+
9+
Below is the steps for contributing new application:
10+
11+
1. Create issue by template **New docker compose request**
12+
2. Waiting for Maintainers/owner Assessment until it is completed.
13+
3. Install Websoft9 at your server or apply online development account from Websoft9
14+
4. SSH to develoment host machine and running below command
15+
```
16+
docker exec -it websoft9-apphub bash /websoft9/script/update_zip.sh --channel dev --package_name "media-dev.zip" --sync_to "/websoft9/media" && docker exec -it websoft9-apphub bash /websoft9/script/update_zip.sh --channel dev --package_name "library-dev.zip" --sync_to "/websoft9/library"
17+
```
18+
5. Login to Websoft9 Console and install this application from **App Store**
19+
6. Develop and test it by **[App compose](https://support.websoft9.com/en/docs/next/app-compose/)** at Websoft9 Console
20+
7. Complete your issue checklist
21+
8. Docker exec **websoft9-apphub** container and pull request to repository
22+
```
23+
# sample for your
24+
docker exec -it websoft9-apphub apphub commit --appid "wordpress" --github_token "yourgithubtoken"
25+
```
26+
27+
## Process diagram
828

929
[Bug report flow](https://www.canva.cn/design/DAFrBuGNCNs/-WGd-D0mQHBu1eZM07d8vQ/edit) as following:
1030

@@ -14,30 +34,26 @@ If you're planning to implement a new feature or change the docker-library repos
1434

1535
![Alt text](./docs/image/feature_request_flow.png)
1636

17-
## Development
37+
## Development Specification
1838

1939
If you want to start to develop this repository, it is very useful for you to read [the develop documentation](docs/code_owner.md)
2040

21-
## Fork
22-
23-
Contributor only allow to fork [main branch](https://github.com/Websoft9/docker-library/tree/main) and pull request for it. Maintainers don't accept any pr to **production branch**
24-
2541
## Branch
2642

2743
This repository have these branchs:
2844

29-
- **Contributor's branch**: Develpoer can fork main branch as their delelopment branch anytime
30-
- **main branch**: The only branch that accepts PR from Contributors's branch
45+
- **dev branch**: Contributor only allow to fork [dev branch](https://github.com/Websoft9/docker-library/tree/dev) and pull request for it.
46+
- **main branch**: It is expected to contain code that is stable and ready for deployment.
3147

32-
Flow: Contributor's branch → main branch
48+
> Maintainers/owner don't accept any pr to **main branch** from developer directly.
3349
3450
## Pull request
3551

3652
[Pull request](https://docs.github.com/pull-requests) let you tell others about changes you've pushed to a branch in a repository on GitHub.
3753

3854
#### When is PR produced?
3955

40-
- Contributor commit to main branch
56+
- Contributor commit to dev branch
4157

4258
#### How to deal with PR?
4359

@@ -63,8 +79,8 @@ Websoft9 use below [Artifact](https://jfrog.com/devops-tools/article/what-is-a-s
6379

6480
### Tags
6581

66-
- Type tags: Bug, enhancement, Documetation
67-
- Stages Tags: PRD, Dev, QA(include deployment), Documentation
82+
- Type tags: RRD, Bug, enhancement, Documetation
83+
- Stages Tags: S-develop, S-fixed and all tags started with `S-`
6884

6985
### WorkFlow
7086

0 commit comments

Comments
 (0)