Hi, Ming just shared a report: https://octoverse.github.com/creating-documentation/#contribution-guidelines
This report says "Why would a company want to add contribution guidelines to its repository? When developers know how to contribute to a repository that belongs to a different team or community, it removes ambiguity and friction, and they are 17% more productive." So the guideline not only provides a clear way to contribute to open source but also removes ambiguity and friction. Best Regards! @ Zhiyuan Ju <https://github.com/juzhiyuan> Zhiyuan Ju <juzhiy...@apache.org> 于2021年11月29日周一 上午7:37写道： > Hi, > > I also support taking apisix-website repo as an example to have a > guideline for newcomers what and how they could do. > > If possible, maybe we could also add good-first-issue list page here? And > let us know if we encounter problems, where we could seek help :) > > > Yilin Zeng <yzen...@wisc.edu.invalid>于2021年11月26日 周五下午2:20写道： > >> Hi community, >> >> >> Currently apisix-website repository[1] does not have a set of blog >> contribution guidelines. It could block potential contributors who want to >> write blogs but cannot find the proper way to do it. As I was reaching out >> to other open-source communities in the last two weeks, I went through some >> of theirs website and blog repositories, and found some valuable guidelines >> that could be implemented in apisix-website repository[1], such as TiDB >> Documentation Contributing Guide[2]. >> >> >> I would like to propose adding contribution guidelines to apisix-website >> repository[1], which will cover the following aspects: >> >> >> 1 What can you contribute >> 1.1 Add a new blog >> 1.2 Fix typos or formats >> >> 2 Contribute style guides >> 2.1 Commit message style >> 2.1 Pull request title style >> >> 3 How to contribute properly via git command line >> >> >> Feel free to share your views, suggestions, or anything else. Thank you! >> >> >> Regards, >> >> Yilin >> >> >> >> [1]https://github.com/apache/apisix-website >> >> [2]https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md >> >> -- > 来自 琚致远 >
