Contributing to Websoft9

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 the api please create an issue first. This way we can ensure that your precious work is not in vain.

Not Sure Architecture?

It's important to figure out the design architecture of Websoft9

Fork

Contributor only allow to fork main branch and pull request for it. Maintainers don't accept any pr to production branch

Branch

This repository have these branchs:

Contributor's branch: Develpoer can fork main branch as their delelopment branch anytime
main branch: The only branch that accepts PR from Contributors's branch
production branch: For version release and don't permit modify directly, only merge PR from main branch

Flow: Contributor's branch → main branch → production branch

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 main branch
main branch commit to production branch

How to deal with PR?

pull request reviews
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:

Dockerhub for image: Access Websoft9 docker images on Dockerhub
Azure Storage for files: Access packages list at Azure Storage

WorkFlow

Websoft9 use the Production branch with GitLab flow for development collaboration

gitlab workflow is improvement model for git

2.9 KiB Raw Blame History