Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 80732d4

Browse files
authored
Merge pull request #1 from AntChainOpenLab/feat/doc_work/update_readme_and_contributing
[doc] update README.md and CONTRIBUTING.md
2 parents 9fd2f45 + f8d5450 commit 80732d4

File tree

3 files changed

+40
-3
lines changed

3 files changed

+40
-3
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@
2222
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
2323
hs_err_pid*
2424
replay_pid*
25+
26+
.idea

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contribution Guidelines
2+
3+
## Branch Strategy
4+
5+
We recommend that developers following the rules [here](https://jeffkreeftmeijer.com/git-flow/git-flow.png).
6+
7+
- Branch `main` with stable code and tags on it.
8+
- Branch `develop` for "next release" development.
9+
- Feature branches start with prefix `feat/`
10+
- Release branches start with prefix `release/`
11+
- Hotfix branches start with prefix `hotfix/`
12+
13+
## Contributing
14+
15+
- Fork the repository.
16+
- Checkout your branch like a feature or bugfix.
17+
- Make a pull request to the `develop` branch of this repository.
18+
- Wait for review and PR merged.
19+
20+
---
21+
22+
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://kcd.im/pull-request)
23+

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
<div align="center">
22
<img alt="am logo" src="https://gw.alipayobjects.com/zos/bmw-prod/3ee4adc7-1960-4dbf-982e-522ac135a0c0.svg" width="250" >
3-
<h1 align="center">Antchain Bridge Plugin Server</h1>
3+
<h1 align="center">AntChain Bridge Plugin Server</h1>
44
<p align="center">
55
<a href="http://makeapullrequest.com">
66
<img alt="pull requests welcome badge" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat">
77
</a>
8+
<a href="https://www.java.com">
9+
<img alt="Language" src="https://img.shields.io/badge/Language-Java-blue.svg?style=flat">
10+
</a>
11+
<a href="https://github.com/AntChainOpenLab/AntChainBridgePluginServer/graphs/contributors">
12+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/AntChainOpenLab/AntChainBridgePluginServer">
13+
</a>
14+
<a href="https://www.apache.org/licenses/LICENSE-2.0">
15+
<img alt="License" src="https://img.shields.io/github/license/AntChainOpenLab/AntChainBridgePluginServer?style=flat">
16+
</a>
817
</p>
918
</div>
1019

1120
# Introduction
1221

13-
Antchain Bridge 插件服务(PluginServer, PS)用于管理异构链插件、完成与中继通信的工作。
22+
AntChain Bridge 插件服务(PluginServer, PS)用于管理异构链插件、完成与中继通信的工作。
1423

1524
- **插件管理能力**
1625

@@ -26,7 +35,7 @@ Antchain Bridge 插件服务(PluginServer, PS)用于管理异构链插件、
2635

2736
**以下插件BCOS和插件ChainMaker均为展示用例,代表不同的异构插件实现*
2837

29-
<img src="https://intranetproxy.alipay.com/skylark/lark/0/2023/jpeg/13456461/1677744080321-3622114c-52c2-432c-9ceb-0f3d07c290e4.jpeg" style="zoom:33%;" />
38+
<img src="https://antchainbridge.oss-cn-shanghai.aliyuncs.com/antchainbridge/document/picture/1677744080321-3622114c-52c2-432c-9ceb-0f3d07c290e4.jpeg" style="zoom:33%;" alt=""/>
3039

3140
# Get Started
3241

@@ -151,3 +160,6 @@ mvn test
151160
152161
敬请期待
153162
163+
# License
164+
165+
详情参考[LICENSE](./LICENSE)。

0 commit comments

Comments
 (0)