Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (84 loc) · 5.76 KB

CONTRIBUTING.md

File metadata and controls

136 lines (84 loc) · 5.76 KB

Contributing

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

If you're planning to implement a new feature or change this repository, please create an issue first. This way we can ensure that your precious work is not in vain.

Quick start for contributing new application

Below is the steps for contributing new application:

  1. Create issue by template New docker compose request
  2. Waiting for Maintainers/owner Assessment until it is completed.
  3. Install Websoft9 at your server or apply online development account from Websoft9
  4. SSH to develoment host machine and running below command to upgrade latest Apps listing 
    docker exec -it websoft9-apphub apphub upgrade apps --dev
  5. Login to Websoft9 Console and install this application from App Store
  6. Develop and test it by App compose at Websoft9 Console
  7. Complete your issue checklist
  8. Docker exec websoft9-apphub container and pull request to repository 
    # sample for your, --appid get from Websoft9 Console, it not appname
docker exec -it websoft9-apphub  apphub commit --appid "wordpress_o2qjz" --github_token "yourgithubtoken"

Copilot-Assisted Development

GitHub Copilot can significantly accelerate the development of Docker Compose applications. Follow these steps to leverage AI assistance:

Prerequisites

  1. Enable GitHub Copilot in your IDE (VS Code, JetBrains, etc.)
  2. Reference Materials: Provide Copilot with the official Docker Compose or container run command from the application's documentation
  3. Template Files: Use docker-library/template/docker-compose.yml and docker-library/template/.env as base templates

Development Workflow

Using GitHub Copilot in Agent Mode

When developing new Docker Compose applications with Copilot, use Agent mode with advanced models (Claude Sonnet, GPT-4, etc.) for best results.

Example Prompt Pattern:

Based on the official [appname] deployment documentation:
- https://github.com/[official-repo]/docker-compose.yml
- https://github.com/[official-repo]/.env
- https://github.com/[official-repo]/README.md

Following our unified template: docker-library\template

Please help me complete the docker-compose orchestration for docker-library\apps\[appname]

Workflow Steps:

  1. Gather Official Documentation

    • Find official docker-compose.yml and .env files
    • Review README for configuration requirements
    • Check for any Docker-specific documentation

  2. Provide Context to Copilot

    • Share official repository URLs
    • Reference template files: docker-library\template\docker-compose.yml and docker-library\template\.env
    • Specify the target app directory: docker-library\apps\[appname]

By combining GitHub Copilot's AI capabilities with proper context and templates, you can dramatically speed up the development process while maintaining quality and consistency.

Process diagram

Bug report flow as following:

Alt text

Feature request flow as following:

Alt text

Development Specification

If you want to start to develop this repository, it is very useful for you to read the develop documentation

Branch

This repository have these branchs:

  • dev branch: Contributor only allow to fork dev branch and pull request for it.
  • main branch: It is expected to contain code that is stable and ready for deployment.

Maintainers/owner don't accept any pr to main branch from developer directly.

Pull request

Pull request let you tell others about changes you've pushed to a branch in a repository on GitHub.

When is PR produced?

  • Contributor commit to dev branch

How to deal with PR?

  1. pull request reviews
  2. Merge RP and CI/CD for it

DevOps principle

DevOps thinks the same way 5m1e for manufacturing companies

We follow the development principle of minimization, rapid release

Version

Use [major].[minor].[patch] for version serial number and version.json for version dependencies

Artifact

Websoft9 use below Artifact for different usage:

Tags

  • Type tags: RRD, Bug, enhancement, Documetation
  • Stages Tags: S-develop, S-fixed and all tags started with S-

WorkFlow

Websoft9 use the Github flow for development collaboration

licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.