Skip to content

Latest commit

 

History

History
57 lines (30 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

57 lines (30 loc) · 3.63 KB
Raw

CONTRIBUTING Guide

如果你希望向awesome-hust中添加条目，建议阅读以下建议。

Use Open Standards, Open Data, Open Source, and Open Innovation.

  1. 这不是广告栏，如果你希望添加商业项目或商业信息，它们应当满足以下条件之一：
using 产品 = variant<软件, 硬件, 工具>;

  • 此收费产品对华中科技大学相当大一部分学生有针对性帮助，且没有任何已知的免费或开源替代产品。

  • 此收费产品具有免费版本，或以内购、增强功能授权、VIP、会员等方式收费。且其免费功能对华中科技大学相当大一部分学生有针对性帮助。

  • 此商业产品仅通过广告形式盈利。

特别地，如果此产品仅通过用户捐助的方式盈利，且捐助用户和非捐助用户的软件具有功能差异。则将捐助视为付费，将此产品视为收费产品。

特别地，非软件作者不允许以营利为目的，对现有产品进行修改、包装或重新分发。

  1. 分享文件或其他资料时，尽可能使用开放、稳定的分享方式，并以HTTP链接的形式给出。如果必要，可以使用GnuPG等工具进行签名和身份验证。分享资料时不应因中国大陆政府对互联网的破坏情况而故意避免或偏好某些分享方式。

  • 以下分享方式是被推荐的

    • Google Drive, Dropbox, 坚果云, Amazon Drive, mega.nz等对文件下载不故意设置障碍的成熟的私有云盘服务。

    • Google Cloud Platform Storage, AWS S3, Aliyun OSS, Microsoft Azure Storage, 腾讯云COS等企业级的可http/https访问的对象存储和托管服务。

    • NextCloud, OwnCloud, Seafile等架设在你自己服务器上的，对文件下载不故意设置障碍的私有云盘服务。

    • GitHub, GitLab, BitBucket, Google Code, 你私有的web服务器, CloudFlare, WebArchive等对资料下载不故意设置障碍的其他服务。

    • 不大于1MiB的人类直接可读的文本文件或图片文件，可以选择放在本项目的res目录下一并提交。

  • 你在分享文件或其他资料时不应当使用以下方式，否则你的Pull Request不会被merge

    • adf.ly、adfoc.us或类似的短链接广告产品。这是因为非软件作者不允许以营利为目的对现有产品进行包装。

    • 百度云盘、腾讯微云、360云盘、微信公众号、QQ空间、QQ群等通过封闭协议客户端限制、不合理的非VIP用户限制等方式, 给文件下载故意设置障碍的资料分享服务。

    • 有明显不合理的访问限制的链接。

    • 含有浏览器漏洞POC代码、网页挖矿代码、DDOS攻击代码、XSS和CSRF攻击代码、明显不合理的用户资料收集代码等恶意代码的链接。必要的透明网页代理、反向代理、网页缓存服务除外。

  1. 为您的项目选择合理的许可证，并检查您的项目的许可描述是否准确（例如不要将不开放源代码的项目称为开源项目）。如果您直接将资料添加到awesome-hust仓库内，您的资料将同awesome-hust索引一起，被视为Public Domain的。

  2. 除非必要，一般不要随意增减条目的类别和分类方式。尽可能只对仓库做最小的修改，尽可能与已有的条目的格式保持统一。

  3. 涉及此仓库的任何文件和外部链接资料中的汉字，如未特殊注明，请默认使用UTF-8编码。

  4. 你可以在awesome-hust的项目底部添加项目作者的捐款链接。

  5. 使用有意义的提交信息。

  6. 减少条目与增加条目同样重要。鼓励有时间的contributor及时移除已失效的项目。