IM/open-im-server

Files

T

History

Wiky Lyu 624ae99a12 fix #2860 migrate jpns to jpush (#2861 )

2024-11-22 08:08:05 +00:00

..

api.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

bash-log.md

fix: fix docker file images proxy (#2071 )

2024-03-11 07:54:33 +00:00

cicd-actions.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

code-conventions.md

feat: Integrate Comprehensive E2E Testing for GoChat (#1906 )

2024-03-04 04:12:14 +00:00

commit.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

development.md

feat: set docs openim-server url address fix (#1043 )

2023-09-08 07:20:30 +00:00

directory.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

environment.md

fix #2860 migrate jpns to jpush (#2861 )

2024-11-22 08:08:05 +00:00

error-code.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

git-workflow.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

gitcherry-pick.md

🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721 )

2024-01-12 10:04:06 +00:00

github-workflow.md

🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721 )

2024-01-12 10:04:06 +00:00

go-code1.md

refactor: 3.7.0 code conventions. (#2148 )

2024-04-19 22:23:08 +08:00

go-code.md

refactor: 3.7.0 code conventions. (#2148 )

2024-04-19 22:23:08 +08:00

go-doc.md

refactor: 3.7.0 code conventions. (#2148 )

2024-04-19 22:23:08 +08:00

images.md

docs: update openim images docs deployment aliyun (#2154 )

2024-03-31 04:40:35 +00:00

init-config.md

🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721 )

2024-01-12 10:04:06 +00:00

install-docker.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

install-openim-linux-system.md

docs: add openim cluster helm chart (#1291 )

2023-10-30 02:16:37 +00:00

kafka.md

feat: Enhancements to OpenIM Engineering Practices with Standardizer and Tool Versioning (#2159 )

2024-04-02 03:31:25 +00:00

linux-development.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

local-actions.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

logging.md

refactor: 3.7.0 code conventions. (#2148 )

2024-04-19 22:23:08 +08:00

mac-developer-deployment-guide.md

feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799 )

2024-01-26 02:02:53 +00:00

offline-deployment.md

Update offline-deployment.md openim offine deployment docs (#1843 )

2024-01-31 06:16:32 +00:00

prometheus-grafana.md

🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721 )

2024-01-12 10:04:06 +00:00

protoc-tools.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

README.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

release.md

🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721 )

2024-01-12 10:04:06 +00:00

test.md

feat: Enhancements to OpenIM Engineering Practices with Standardizer and Tool Versioning (#2159 )

2024-04-02 03:31:25 +00:00

util-go.md

☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359 )

2023-11-10 11:37:25 +00:00

util-makefile.md

feat: add openim docker compose and env (#1550 )

2023-12-12 08:44:02 +00:00

util-scripts.md

docs: fix english typo (#2432 )

2024-07-24 06:50:02 +00:00

version.md

docs: Update openim version management strategy, detailed design (#2076 )

2024-03-18 02:34:19 +00:00

README.md

Contrib Documentation Index

📚 General Information

📄 README - General introduction to the contribution documentation.
📑 Development Guide - Guidelines for setting up a development environment.

🛠 Setup and Installation

🌍 Environment Setup - Instructions on setting up the development environment.
🐳 Docker Installation Guide - Steps to install Docker for container management.
🔧 OpenIM Linux System Installation - Guide for installing OpenIM on a Linux system.

💻 Development Practices

👨‍💻 Code Conventions - Coding standards to follow for consistency.
📐 Directory Structure - Explanation of the repository's directory layout.
🔀 Git Workflow - The workflow for using Git in this project (note the file extension error).
💾 GitHub Workflow - Workflow guidelines for GitHub.

🧪 Testing and Deployment

⚙️ CI/CD Actions - Continuous integration and deployment configurations.
🚀 Offline Deployment - How to deploy the application offline.

🔧 Utilities and Tools

📦 Protoc Tools - Protobuf compiler-related utilities.
🔨 Utility Go - Go utilities and helper functions.
🛠 Makefile Utilities - Makefile scripts for automation.
📜 Script Utilities - Utility scripts for development.

📋 Standards and Conventions

🚦 Commit Guidelines - Standards for writing commit messages.
✅ Testing Guide - Guidelines and conventions for writing tests.
📈 Versioning - Version management for the project.

🖼 Additional Resources

🌐 API Reference - Detailed API documentation.
📚 Go Code Standards - Go programming language standards.
🖼 Image Guidelines - Guidelines for image assets.

🐛 Troubleshooting

🔍 Error Code Reference - List of error codes and their meanings.
🐚 Bash Logging - Logging standards for bash scripts.
📈 Logging Conventions - Conventions for application logging.
🛠 Local Actions Guide - How to perform local actions for troubleshooting.