今天我们就通过例子说明如何维护好一个Python开源项目,需要我们注意哪些方面呢?
说明简介要清楚
无论任何的Python开源项目,它都要有三样东西,Python项目目标和方法的简要说明,如何参与和授权许可等。最好把它们预先放在一个说明的文本文件里面去。
加入一个名为“组织和理念”的部分,概括项目如何构成的。各个东西都在哪儿,代码是怎样写的,需要哪些类型的测试性能与简洁性怎么平衡,详细请见案例unstdlib.py程序。要说清楚开发者怎样开始参与项目,以及将代码成功的合并进项目步骤,urllib3贡献的部分,已经被其他好几个项目采用。
1、查看还没有解决的问题,或者新开一个问题来讨论某个功能设想或bug。
2、把urllib3库添加到Github上开始进行更改。
3、编写测试来显示这个bug是固定的或者它的功能是否正如预料的那样运行。
4、发送一个pull请求,干扰保持器,直到它被合并到一起并发布。
5、最后,每一个开源项目需要有一个授权许可,如果没有许可,那就意味着版权属于开发者,其他人需要明确的许可才能使用。
耐心热情
对用户和贡献者有好的态度是至关重要,偶尔会有类库用户误闯到你的问题跟踪器里,并且很愚蠢的在文档编制里写了命令。
你可能会斥责用户,他们的鲁莽行为浪费了你很多时间,你也可以耐心的向用户解释给用户听,一旦他们进一步理解问题,那么邀请他们发送一个pull请求为其他的用户改善文件编制。
有些团队可能因为某些原因选择第一种态度,也许是因为他们觉得维护人员做的是一件吃力不讨好的工作,还要承担丢失贡献者的责任,不过先来检查一下这两种态度所带来的效果。
当你责怪用户,毫无疑问会丢失用户的,还意味着丢失了他成为你的贡献者的可能性,说不定这种影响会传播到其他人那里,一传十十传百。别人可能真的认为你的文件编制里有问题,这无异于搬石头砸自己的脚。
但只要你有足够的耐性,鼓励他们为项目出力,他们就会很有斗志。说不定他们就能在项目上做出重大影响,彻底改变现状。
在工作中保持良好的态度可能是比较难的一部分,因为每个维护人员的情况是不一样的,但是,礼貌、积极和进步是至关重要的。不仅仅是对于你和项目,还有整个团队。
推广营销
你能写出最有用最完美的代码并实现代码运行,但是你对技术社区的贡献会因为你允许人们重复使用你的代码而无限放大。
找到你的项目,站在SEO的位置思考整个项目,为项目选取一个带有重要关键词的相关名称。README里的项目描述和第一段应该是项目的简单总结,里面所有的重要关键词都是之前人们所搜索的。
充足的时间,我的一个比较受欢迎的项目花了至少一年的时间。这在营销人员看来是懒散的表现,但如果你按照文章里说的那样去做,正确的完成每一件事,那么营销人员会不请自来。
urllib3——带有线程安全连接池的Python HTTP类库,支持文件公布,智能友好等等。
Python,HTTP类库,线程安全,连接池,文件公布,这些都是当人们遇到要使用Python的标准HTTP类库(urllib、urllib2、httplib)的时候所需要的。
为受众提供技术支持,建立一些StackOverflow警报过滤器,甚至可以过滤掉谷歌的奇怪论坛警报,这个警报会帮助你添加一个你就是开发者的免责声明的。
玩蛇网文章,转载请注明出处和文章网址:https://www.iplaypy.com/news/a110.html
相关文章 Recommend