RFC: OpenIM engineering design

[cubxxw]

RFC: OpenIM engineering design

Problem

Currently, OpenIM lacks a clear and consistent structure, making it difficult for developers to work with and improve. In addition, the GitHub actions workflow needs to be optimized and automated for increased efficiency.

The following order of priority is based on our design goals 🎯

RFC:

Improve Makefile Structure

• Improve Makefile structure #389

We propose the following Makefile structure improvements, sorted by priority:

1. Implement optional copyright check (if not already implemented by actions).
2. Automatically parse help information for all makefile options.
3. Ensure consistent behavior, such as enforcing commit guidelines.
4. Add necessary options, such as unit test coverage (which we care about but currently do not provide).
5. Add debug information and selective debugging. Also, consider providing options to selectively generate binaries via open_im_cms_api or open_im_msg_gateway to improve compile speed.
6. Simplify the /Makefile module for readability.
7. The makefile provides cross-compilation
8. The Makefile docker-in-docker does not fully support amd/arm

Optimize GitHub Actions Workflow

• Optimize directory structure #421

The following changes will be made to optimize the GitHub Actions workflow:

1. Provide and automate CHANGELOG management.
2. Add automation for micro-operations and functionality not currently covered.

Improve Version Control

We propose creating separate versions for openim system information (git information, Go information, etc.) and pkg runtime. We suggest moving the core of openim's commands (especially alpha extensions) to the /internal directory (internal access only) and /pkg directory (allowing for calls). Additionally, we propose supplementing relevant documentation, such as version API and Makefile guidelines.

Tasks

Type	Improvement	Issues	PR	Status	Priority
Makefile	Improve Makefile structure	#389		✅	🥇
Directory Design	Optimize directory structure	#421		✅	🥈
GitHub Actions	Optimize actions workflow	#468		✅	🥉
Version Control	Separate versions for OpenIM system and pkg runtime, move core commands to /internal and /pkg directories, supplement documentation	#574		❌	⛽

[kubbot]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[kubbot]

This issue was closed because it has been stalled for 7 days with no activity.