version-control - 使项目开源时要考虑什么?

标签 version-control open-source

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题?更新问题,以便 editing this post 可以用事实和引用来回答它.

6年前关闭。




Improve this question




我正要发布一个开源项目,我真的很想得到一些关于以下几点的反馈:

  • 代码很干净,但版本控制历史却不是。错误、调试代码、可能是不适当的代码等。我应该在发布之前清除历史记录,还是将其导入公共(public)存储库?
  • 我应该优先制作教程、功能说明或 api 文档吗?
  • 让人们更容易进入新项目的其他想法?
  • 最佳答案

    以我非常谦虚的观点:

    1) 如果您打算开源,请为您的代码感到自豪。我们都知道在此过程中存在错误和错误。还会有更多,所以不要觉得你不能公开展示这些。你可以!

    2) 绝对。可能在这方面,订单也是如此,因为这是使用您的产品的人将要阅读它们的顺序。他们必须在决定使用您的软件之前使用它。

    3)我能给出的最好建议是有明确的构建说明,希望有脚本来帮助人们配置环境。开源软件的一个常见问题是要求新开发人员下载大量库并配置他们的机器以使其正常工作,以便能够构建软件。对我来说,这非常令人沮丧,并且很快就会让我失望。

    祝你好运!

    关于version-control - 使项目开源时要考虑什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1475209/

    相关文章:

    java - 以下未跟踪的工作树文件将被覆盖

    java - 如何为 sourceforge 的开源项目配置环境

    open-source - 静态类型开源跨平台现代编程语言

    git - 在 Git 中重新定位远程分支

    纸质文档的SVN标签实践

    具有选定或限制子模块列表的 Git 子模块 foreach

    德尔福文件类型

    .net - 签署开源项目的二进制文件

    open-source - 如何处理死掉的开源依赖?

    linux - 开源魔眼发生器