开源规则_开源项目的10条规则

本文列举了开源项目的10条重要规则,包括不完整的项目也值得分享,明确优于隐含,谨慎发布,遵循社区模式,编写测试,不要依赖社区帮助,重视文档,提供教程和内容,建立社区等,旨在指导开源项目的发展和成功。
摘要由CSDN通过智能技术生成

开源规则

1.不完整总比没有好 (1. Something incomplete is better than nothing at all)

If you have a piece of code and you think it is useful. Share it to the community, if this is a code snippet you can share in the form of a gist on github. 

如果您有一段代码,并且您认为它很有用。 共享给社区,如果这是一个代码片段,您可以在github上以要点的形式共享。

Even if this is an incomplete peace of software put it on github. Maybe missing documentation, tests and code cleanup but share it anyway! 

即使这是软件的不完全和平,也可以将其放在github上 。 也许会丢失文档,测试和代码清除,但还是要共享!

If this is only an idea, put it in aREADME file or post in to a blog.

如果仅是个主意,请将其放入自述文件或发布到博客中。

2.显式胜于隐式(老实) (2. Explicit is better than implicit (be honest))

Always include advices and notes in your project README or in code comments. If the code is incomplete and you are not sure if this is safe, please make it explicit to the community.

始终在项目自述文件或代码注释中包含建议和注释。 如果代码不完整,并且您不确定这样做是否安全,请向社区公开。

You can simply put CAUTION note: 

您可以简单地提请注意:

“Use at your own risk” or “Untested alpha version do not use in prodution” notes on the project page.

项目页面上的“使用后果 自负”或“ 未经测试的Alpha版本请勿用于生产”注释。

3.小心释放 (3. Release it carefully

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值