帮酷LOGO
0 0 评论
  • 显示原文与译文双语对照的内容
文章标签:开源  默认  DEF  template  文件  Projects  proj  项目模板  
A project template containing default open source files for new projects

  • 源代码名称:open-source-project-template
  • 源代码网址:http://www.github.com/cfpb/open-source-project-template
  • open-source-project-template源代码文档
  • open-source-project-template源代码下载
  • Git URL:
    git://www.github.com/cfpb/open-source-project-template.git
  • Git Clone代码到本地:
    git clone http://www.github.com/cfpb/open-source-project-template
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/cfpb/open-source-project-template
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
  • CFPB开放源代码项目模板说明
    • 创建一个新项目。
    • 将这些文件复制到新项目中。
    • 更新自述文件,按规定替换下面的内容。
    • 将源代码库中的源代码。资源或者硬依赖项添加到项目存储库中,这些库将包含在项目的repository异常部分中。
    • 如果不需要例外,从术语中删除那部分。
    • 如果使用现有代码库,请在源代码清单上回答问题。
    • 删除这些说明以及从README项目标题到项目标题的所有内容。
    • 编写一些优秀的软件并告诉人们。

    让自述器保持新鲜这是人们首先看到的,将会使初始的印象变得。

    安装

    要安装所有模板文件,请从你的项目目录的root 运行以下脚本:

    
    bash -c"$(curl -s https://raw.githubusercontent.com/CFPB/development/master/open-source-template.sh)"
    
    
    
    
    项目标题

    描述: 对这个项目试图完成的项目进行有意义。简短。简明的描述。 描述这个项目解决的问题。 描述这里软件如何改善它的访问者的生活。

    要包括的其他内容:

    • 英镑技术堆栈:说明软件的技术性质,包括主要编程语言,以及软件在框架或者其他生态系统中是独立的还是作为一个独立的。
    • 状态: Alpha,测试版,1.1,等等 也可以写一个句子。 目标是让感兴趣的人知道这个项目在哪里。 这也是一个链接到变更日志文件的好地方。
    • 为生产或者演示实例 链接
    • 描述哪些sets与相关项目 apart。 如果不能在句子或者两个语句中表达,则链接到另一个文档或者页面是可以的。

    如果软件有可视组件,请在描述之后放置一个屏幕截图,e.g.,

    依赖项

    描述必须为该软件安装的所有依赖项。 这包括编程语言。数据库或者其他存储机制。构建工具。框架等等。 如果需要其他软件的特定版本,或者知道不工作,请调用。

    安装

    关于如何安装,配置和使项目运行的详细说明。 应该经常进行测试以确保可靠性。 或者,链接到单独的安装插件文档。

    配置

    如果软件可以配置,请详细描述它,或者在你所链接的其他文档中详细说明。

    用法

    向用户展示如何使用软件。 具体说明。在显示代码段时使用适当的格式。

    :如何测试软件

    如果软件包括自动化测试,那么详细说明如何运行这些测试。

    已知问题

    用软件记录任何已知的重大缺陷。

    获取帮助

    指示用户如何获取这里软件的帮助;这可能包括指向问题跟踪程序。wiki。邮件列表等的链接。

    示例

    如果你有问题。关注事项。Bug 报告等,请在这个库跟踪程序中提出问题。

    涉及到

    这个部分将详细介绍为什么人们应该参与并描述你当前关注的关键领域;比如,试图获得关于特性的反馈,修复某些 Bug,构建重要的Fragment等等。

    关于的一般说明如何贡献应该用一个指向贡献的链接 stated。

    开放源代码许可信息

    Credits和引用

    • 激发你灵感的项目
    • 相关项目
    • 书籍。论文。谈话或者其他对本项目有意义影响或者影响的来源


    文章标签:文件  Source  proj  files  开源  template  DEF  Projects  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语