blob: 875da97188bc16085773a75b8495995c11eb4cd6 [file] [log] [blame]
<!doctype html>
<!--
Minimal Mistakes Jekyll Theme 4.4.1 by Michael Rose
Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
Free for personal and commercial use under the MIT license
https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt
-->
<html lang="cn" class="no-js">
<head>
<meta charset="utf-8">
<!-- begin SEO -->
<title>如何做贡献 - Apache ServiceComb</title>
<meta name="description" content="如何做贡献">
<meta name="author" content="">
<meta property="og:locale" content="cn">
<meta property="og:site_name" content="Apache ServiceComb">
<meta property="og:title" content="如何做贡献">
<link rel="canonical" href="https://github.com/pages/apache/incubator-servicecomb-website/cn/developers/contributing">
<meta property="og:url" content="https://github.com/pages/apache/incubator-servicecomb-website/cn/developers/contributing">
<meta property="og:description" content="如何做贡献">
<meta name="twitter:site" content="@ServiceComb">
<meta name="twitter:title" content="如何做贡献">
<meta name="twitter:description" content="如何做贡献">
<meta name="twitter:url" content="">
<meta name="twitter:card" content="summary">
<script type="application/ld+json">
{
"@context" : "http://schema.org",
"@type" : "Person",
"name" : "Apache ServiceComb",
"url" : "https://github.com/pages/apache/incubator-servicecomb-website",
"sameAs" : null
}
</script>
<meta name="google-site-verification" content="HvJjNd7vvJ-yjSTHlBiIWEYxp_Hrz-PYEY5Idz9LRcA" />
<!-- end SEO -->
<link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache ServiceComb Feed">
<!-- http://t.co/dKP3o1e -->
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script>
document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js ';
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
<script src="/assets/vendor/prism/prism.js"></script>
<script type="text/javascript" async
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">
<script src="https://www.apachecon.com/event-images/snippet.js"></script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js" integrity="sha384-b/U6ypiBEHpOf/4+1nzFpr53nxSS+GLCkfwBdFNTxtclqqenISfwAzpKaMNFNmj4" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/js/bootstrap.min.js" integrity="sha384-h0AbiXch4ZDo7tp9hKZ4TsHbi047NrKGLO3SEJAg45jXxnGIfYzk4Si90RDIqNm1" crossorigin="anonymous"></script>
<!-- For all browsers -->
<link rel="stylesheet" href="/assets/css/main.css">
<link rel="stylesheet" href="/assets/vendor/prism/prism.css">
<!--[if lte IE 9]>
<style>
/* old IE unsupported flexbox fixes */
.greedy-nav .site-title {
padding-right: 3em;
}
.greedy-nav button {
position: absolute;
top: 0;
right: 0;
height: 100%;
}
</style>
<![endif]-->
<meta http-equiv="cleartype" content="on">
<!-- start custom head snippets -->
<!-- insert favicons. use http://realfavicongenerator.net/ -->
<link href="https://fonts.loli.net/css?family=Roboto:400,500,700|Source+Code+Pro" rel="stylesheet">
<script src="/assets/js/custom.js"></script>
<!-- end custom head snippets -->
</head>
<body class="layout--single">
<!--[if lt IE 9]>
<div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</div>
<![endif]-->
<div class="masthead" onmouseleave="$('#childrenShow').css('display', 'none')">
<div class="masthead__inner-wrap">
<div class="masthead__menu">
<nav id="site-nav" class="greedy-nav">
<a class="site-title active" href="/cn"><img src="https://www.apache.org/img/servicecomb.png"></a>
<ul class="visible-links">
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/">首页</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/developers/">项目</a>
</li>
<li class="def-nav-li" onmouseenter="$('#childrenShow').css('display', 'block')">
<a href="/cn/docs/users/">文档</a>
<ul id="childrenShow" class="def-children-show-cn" onmouseleave="$('#childrenShow').css('display', 'none')">
<li><a href="/cn/docs/getting-started/" class="">入门指南</a></li>
<li><a href="/cn/docs/users/" class="">用户手册</a></li>
<li><a href="/cn/slides/" class="">大咖视频</a></li>
<li><a href="/cn/faqs/" class="">常见问题</a></li>
</ul>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/year-archive/">博文</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/release/">下载</a>
</li>
</ul>
<button><div class="navicon"></div></button>
<ul class="hidden-links hidden"></ul>
<div class="nav-lang">
<a href=/developers/contributing>English</a>
</div>
</nav>
</div>
</div>
</div>
<div id="main" role="main">
<div class="sidebar sticky">
<div class="back-to-home"><a href="/cn/">首页</a> > 如何做贡献</div>
<nav class="nav__list">
<input id="ac-toc" name="accordion-toc" type="checkbox" />
<label for="ac-toc">切换菜单</label>
<ul class="nav__items">
<li>
<a href="/cn/developers/"><span class="nav__sub-title nav__sub-title-with-url">项目列表</span></a>
</li>
<li>
<a href="/cn/developers/team/"><span class="nav__sub-title nav__sub-title-with-url">开发团队</span></a>
</li>
<li>
<a href="/cn/developers/contributing"><span class="nav__sub-title nav__sub-title-with-url">如何做贡献</span></a>
</li>
<li>
<a href="/cn/developers/becomming-a-commiter"><span class="nav__sub-title nav__sub-title-with-url">成为Committer</span></a>
</li>
<li>
<a href="/cn/developers/setup-develop-environment/"><span class="nav__sub-title nav__sub-title-with-url">开发环境准备</span></a>
</li>
<li>
<a href="/cn/developers/submit-issues/"><span class="nav__sub-title nav__sub-title-with-url">发现问题</span></a>
</li>
<li>
<a href="/cn/developers/submit-codes/"><span class="nav__sub-title nav__sub-title-with-url">代码提交指南</span></a>
</li>
<li>
<a href="/cn/developers/subscribe-mail-list/"><span class="nav__sub-title nav__sub-title-with-url">邮件列表订阅指南</span></a>
</li>
<li>
<a href="/cn/developers/use-jira/"><span class="nav__sub-title nav__sub-title-with-url">JIRA使用方法</span></a>
</li>
<li>
<a href="/cn/developers/use-gitter/"><span class="nav__sub-title nav__sub-title-with-url">Gitter 使用方法</span></a>
</li>
<li>
<a href="/cn/developers/setup-committer-rights/"><span class="nav__sub-title nav__sub-title-with-url">设置代码仓库写权限</span></a>
</li>
<li>
<a href="/cn/developers/release-guide/"><span class="nav__sub-title nav__sub-title-with-url">Servicecomb发版指南</span></a>
</li>
<li>
<a href="/cn/developers/release-validation-guide/"><span class="nav__sub-title nav__sub-title-with-url">ServiceComb发版验证指南</span></a>
</li>
<li>
<a href="/cn/developers/sonarcloud-how-to/"><span class="nav__sub-title nav__sub-title-with-url">SonarCloud集成指南</span></a>
</li>
</ul>
</nav>
</div>
<article class="page" itemscope itemtype="http://schema.org/CreativeWork">
<meta itemprop="headline" content="如何做贡献">
<meta itemprop="description" content="如何做贡献">
<meta itemprop="dateModified" content="May 20, 2018">
<div class="page__inner-wrap">
<header>
<h1 class="page__title" itemprop="headline">如何做贡献
</h1>
</header>
<section class="page__content" itemprop="text">
<aside class="sidebar__right">
<nav class="toc">
<!-- <header><h4 class="nav__title"><i class="fa fa-file-text"></i> 在本页上</h4></header> -->
<ul class="toc__menu" id="markdown-toc">
<li><a href="#为apache-servicecomb做贡献" id="markdown-toc-为apache-servicecomb做贡献">为Apache ServiceComb做贡献</a></li>
<li><a href="#初次接触" id="markdown-toc-初次接触">初次接触</a></li>
<li><a href="#改进文档" id="markdown-toc-改进文档">改进文档</a></li>
<li><a href="#如果发现了一个bug或问题" id="markdown-toc-如果发现了一个bug或问题">如果发现了一个Bug或问题</a></li>
<li><a href="#编写代码" id="markdown-toc-编写代码">编写代码</a></li>
</ul>
</nav>
</aside>
<h2 id="为apache-servicecomb做贡献">为Apache ServiceComb做贡献</h2>
<p>您可以通过很多方式帮助ServiceComb成长为更优秀的微服务框架——非常欢迎伸出援手!</p>
<ul>
<li>浏览文档,这样可以加深您对ServiceComb的了解,学习到知识,一旦发现文档写得不清晰或逻辑混乱的地方,请通知我们;</li>
<li>下载代码,试一试我们介绍的功能,看看它是否与您预想的一样工作;</li>
<li>分析源代码,如果希望了解更多技术细节,请在 <a href="https://github.com/apache/servicecomb-java-chassis">Issue</a> 上提问,大家会尽快解答;</li>
<li>希望炫一把黑科技体现您的实力?看看我们的 <a href="https://issues.apache.org/jira/browse/SCB">issue tracker</a> 吧,欢迎您承接Open状态的Issues和未完成的特性,提交 <a href="http://servicecomb.apache.org/cn/developers/submit-codes/">PR</a> ,成为贡献者之一;</li>
<li>如果您接触 ServiceComb不久并且很希望帮助我们,您可以先从 <a href="https://issues.apache.org/jira/browse/SCB-333?jql=project%20%3D%20SCB%20AND%20status%20%3D%20Open%20AND%20fixVersion%20in%20(EMPTY%2C%20java-chassis-1.0.0-m2)%20AND%20labels%20%3D%20newbie">简单的任务</a> 入手,循序渐进,甚至成长为Committer;</li>
<li>如果在使用ServiceComb的过程中发现有功能无法满足您的需求或出现问题,请在Issues中记录,并Watch项目,这样一旦这个问题有进展,都会第一时间通知到您。</li>
</ul>
<h2 id="初次接触">初次接触</h2>
<p>有下面的方式加入ServcieComb社区:</p>
<ul>
<li>订阅我们的 <a href="http://servicecomb.apache.org/cn/developers/subscribe-mail-list">邮件列表</a> ,并为您关注的话题发表意见;</li>
</ul>
<h2 id="改进文档">改进文档</h2>
<p>文档是用户了解Apache ServiceComb最主要的方式,也是我们最需要帮助的地方!</p>
<p>因此如果您对改进文档的质量感兴趣,不论是修订一个页面的地址、更正一个链接、以及写一篇更优秀的入门文档,我们都非常欢迎!</p>
<p>我们的文档大多数是使用markdown格式编写的,您需要同步我们的 <a href="https://github.com/apache/servicecomb-website">Website</a> 项目,直接在 github上编辑后提交PR即可。</p>
<h2 id="如果发现了一个bug或问题">如果发现了一个Bug或问题</h2>
<p>请提交一个新的Issue在我们的 <a href="https://issues.apache.org/jira/browse/SCB">issue tracker</a> 上,如果您能够提供一个JUnit测试用例来复现这个问题,那么我们就能够更快的解决它,例如已经有的 <a href="https://github.com/apache/servicecomb-pack/tree/master/alpha/alpha-core/src/test/java/org/apache/servicecomb/pack/alpha/core">例子</a> ,并且我们还能够持续的确认这个问题不会再次出现在未来的版本中。</p>
<h2 id="编写代码">编写代码</h2>
<p>ServiceComb的所有项目都在 <a href="https://github.com/search?q=org%3Aapache+servicecomb">Github</a> 上,包含下面几个子项目:</p>
<table>
<thead>
<tr>
<th>项目名</th>
<th>项目简介</th>
<th>编程语言</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://github.com/apache/servicecomb-java-chassis">servicecomb-java-chassis</a></td>
<td>Java微服务框架(SDK)</td>
<td>Java</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-service-center">servicecomb-service-center</a></td>
<td>服务中心(服务注册及发现)</td>
<td>Golang</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-pack">servicecomb-pack</a></td>
<td>支持Saga/TCC等多协议的分布式事务方案</td>
<td>Java</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-Mesher">servicecomb-mesher</a></td>
<td>微服务网格</td>
<td>Golang</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-kie">servicecomb-kie</a></td>
<td>微服务配置管理中心</td>
<td>Golang</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-toolkit">servicecomb-toolkit</a></td>
<td>基于契约的微服务开发工具</td>
<td>Java</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-samples">servicecomb-samples</a></td>
<td>提供了微服务示例</td>
<td>Java</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-fence">servicecomb-fence</a></td>
<td>ServiceComb Java-chassis安全认证解决方案</td>
<td>Java</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-docs">servicecomb-docs</a></td>
<td>ServiceComb用户手册</td>
<td>CSS</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-website">servicecomb-website</a></td>
<td>ServiceComb网站</td>
<td>HTML</td>
</tr>
<tr>
<td><a href="https://github.com/apache/servicecomb-saga-actuator">servicecomb-saga-actuator</a></td>
<td>集中式Saga事务协调器 (归档)</td>
<td>Java</td>
</tr>
</tbody>
</table>
<p>如果希望给ServiceComb提交代码,您需要从github上fork对应的项目至您的项目空间下,为您提交的代码创建一个新的分支,添加源项目为upstream,并提交PR,更详细的步骤可以参考 <a href="http://servicecomb.apache.org/cn/developers/submit-codes/">这篇文档</a></p>
</section>
<footer class="page__meta">
</footer>
</div>
</article>
</div>
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<div align="center" style="margin: 0 0;">
<ins class="adsbygoogle"
style="display:block; border-bottom: initial;"
data-ad-client="ca-pub-7328585512091257"
data-ad-slot="3049671934"
data-ad-format="auto"></ins>
</div>
<div class="page__footer">
<footer>
<!-- start custom footer snippets -->
<!-- end custom footer snippets -->
<div class="container">
<div class="row justify-content-md-center">
<div class="col">
<ul>
<p class="header">活动</p>
<a class="acevent" data-format="square" data-mode="dark" data-event="random"></a>
</ul>
</div>
<div class="col">
<ul>
<p class="header">资源</p>
<li><a href="/cn/docs/getting-started/">入门指南</a></li>
<li><a href="/cn/docs/users/">用户指南</a></li>
<li><a href="/cn/slides/">资料</a></li>
<li><a href="/cn/users/faq/">常见问题</a></li>
</ul>
</div>
<div class="col">
<ul>
<p class="header">ASF</p>
<li><a href="http://www.apache.org">基金会</a></li>
<li><a href="http://www.apache.org/licenses/">许可证</a></li>
<li><a href="http://www.apache.org/events/current-event">活动</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html">赞助</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">鸣谢</a></li>
</ul>
</div>
<div class="col">
<ul>
<p class="header">贡献</p>
<li><a href="http://issues.apache.org/jira/browse/SCB">报告本网页问题</a></li>
<li><a href="https://github.com/apache/servicecomb-website/edit/master/_developers/cn/contributing.md">在Github上编辑此页</a></li>
<li><a href="/cn/developers/submit-codes/">代码提交指南</a></li>
<li><a href="/cn/security">安全</a></li>
</ul>
</div>
<div class="col">
<ul class="social-icons">
<p class="header">社区</p>
<li>
<a href="mailto:dev-subscribe@servicecomb.incubator.apache.org" rel="nofollow"><span class="mail">邮件列表</span></a>
</li>
<li>
<a href="https://github.com/apache?q=ServiceComb" target="_blank"><span class="github">Github</span></a>
</li>
<li>
<a href="https://twitter.com/ServiceComb" target="_blank"><span class="twitter">Twitter</span></a>
</li>
<li>
<a href="/feed.xml" target="_blank"><span class="rss">Feed</span></a>
</li>
</ul>
</div>
</div>
</div>
<div class="page__footer-bottom">
<div>&copy; 2024 Apache ServiceComb. 技术来自于 <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> &amp; <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</div>
<div>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
</footer>
</div>
<script src="/assets/js/main.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-101622733-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>