Clojure

Contributing to This Site

该网站是https://clojure.org上托管的有关Clojure编程语言及其更广泛的生态系统的内容的开源资源库.

如果您想指出站点中的问题或提议新页面,可以通过在https://github.com/clojure/clojure-site/issues上提交GitHub问题来实现.

如果您想做出贡献(打字,修改或新内容),则必须成为贡献者并使用以下所述的过程:

How To Become a Contributor

提交更改之前,参与者必须签署《 Clojure贡献者协议》. 贡献者协议 (CA)使Rich Hickey和贡献者拥有共同的版权权益:贡献者保留版权,同时也将这些权利授予Rich Hickey作为开源项目的赞助者.

CA源自Oracle贡献者协议(OCA),用于OpenJDK,Netbeans和OpenSolaris项目以及其他项目. 有一个很好的OCA常见问题解答,可以回答很多问题.

通过执行CA,贡献者可以保护Clojure网站的内容并保护灵活性,以使项目适应社区不断变化的需求. 为了使CA有效,Clojure项目必须获得所有贡献的任务. 请查看CA,以全面了解其条款和条件. 通过向Clojure提供源代码或其他材料,您表示您拥有具有Rich Hickey的CA,可以进行此类贡献. 为了跟踪贡献者,您了解您的全名和用户名可能会发布在列出授权贡献者的网页上,可通过公共URL对其进行访问.

要完成协议,请填写并提交贡献者协议 (在线电子表单).

请注意,如果您已经签署了Clojure贡献者协议以提供Clojure源代码的补丁,则无需再次签名,因为它是同一协议.

Submitting Small Changes

可以在GitHub Web界面中直接提出一些小的更改:

  1. 转到内容存储库https://github.com/clojure/clojure-site

  2. 导航到您要在content /下更新的页面-网址应与文件库名称匹配. 例如,此文件的内容位于https://github.com/clojure/clojure-site/blob/master/content/community/contributing_site.adoc .

  3. 单击编辑(铅笔)图标.

  4. 内容使用asciidoc格式编写,类似于Markdown. " 编辑"页面列出了在此站点上编辑内容时遇到的最常见情况的示例. 在文本框中进行更改. 您可以使用"预览更改"选项卡预览更改. GitHub理解asciidoc格式,并将提供您所做更改的格式化预览.

  5. 在页面底部写下更改的简要说明,然后单击"建议更改文件". 这会将原始存储库派生到您自己的版本库中,并应用更改.

  6. 然后,您将看到"比较更改"页面-所有信息应自动填写,更改摘要将显示在底部-这是一个再看一次的好时机. 假设一切看起来正确,您可以通过单击"创建拉取请求"将更改建议回原始存储库. 然后,您可以在拉取请求本身中添加评论,然后单击"创建拉取请求".

Submitting Large Changes

对于任何重大更改, 请先打开一个问题并讨论更改,然后再花一些时间.

如果您要创建一个全新的页面或进行重大更改而需要多次提交,则可能会发现使用命令行工具更轻松.

创建本地环境以进行更大的更改:

  1. 分叉内容存储库https://github.com/clojure/clojure-site-这将在您自己的用户ID下创建网站内容的版本.

  2. git clone在您的本地终端和cd clojure-site git clone分支的存储库.

  3. git checkout -b <branchname> -创建一个新分支来处理您的更改. 您将使用此分支来提交拉取请求.

  4. 在此分支上进行一次或多次提交,修改或添加一个或多个文件. 请参阅以下部分,了解如何在本地构建和预览更改. " 编辑"页面列出了在此站点上编辑内容时遇到的最常见情况的示例.

  5. 使用git push将更改git push送到分支.

  6. 转到https://github.com/username/clojure-site/tree/branchname.

  7. 单击绿色按钮以"比较,查看和创建请求请求",然后按照提示进行操作以提交请求请求.

为了积极地对该站点做出贡献,重要的是使您自己的fork与该存储库保持最新. 要做到这一点:

  1. 将此存储库添加到您的远程URL: git remote add upstream https://github.com/clojure/clojure-site.git .

  2. 每次贡献之前:

    • 获取上游的内容: git fetch upstream

    • 移至您的master分支: git checkout master (以防您尚未进入该分支);

    • 通过将HEAD git reset --hard upstream/master为获取的分支来清理您的master分支,进行任何计划外的修改: git reset --hard upstream/master ; 和

    • 如上所述创建一个新分支: git checkout -b <branchname>

Building and Previewing Changes

在进行较大的更改时,在本地构建站点很有用. 该网站是使用JBake构建的 .

安装 JBake 2.6.3:

  1. curl -O https://dl.bintray.com/jbake/binary/jbake-2.6.3-bin.zip (或使用浏览器下载此文件)

  2. unzip -o jbake-2.6.3-bin.zip

  3. 将jbake-2.6.3-bin / bin添加到系统路径

建立网站:

检索内容:

  1. git clone https://github.com/clojure/clojure-site.git (或您自己的fork)

  2. cd clojure-site

检索并安装当前主题资产(这些资源不会经常更改,因此您不必每次都这样做):

  1. curl -O https://clojure.org/clojuretheme.zip (或使用浏览器将此文件下载到clojure-site目录)

  2. unzip -o clojuretheme.zip

生成页面:

  1. jbake -b这将在输出目录中创建静态站点

  2. To view the static files, open output/index in your browser

  3. 要查看实时预览,请运行jbake -s并转到http:// localhost:8820 / index

Style and Navigation Changes

我们目前不希望整体网站的样式,导航或基础结构发生变化. 该领域正在进行的工作将在不久的将来可见.

如果您在这些方面有问题,请提出问题,而不是提出要求.

How Contributions are Reviewed and Deployed

提交请求请求后,贡献将等待审核.

对于每个拉取请求,另外一名审阅者将采取行动:

  • 用已审阅标签标记评论. 这表示审阅者批准更改,并请求编辑者合并这些更改.

  • 对请求请求的注释提出其他更改. 您可以通过在本地分支上进行进一步的提交来解决这些更改.

  • 用注释结束拉取请求,并指出为什么更改不适当.

Thanks!

感谢您的贡献!

Terms of Use

版权所有©2019 Rich Hickey和贡献者

除非另有说明,否则此存储库中包含的所有文档均由Rich Hickey根据Eclipse Public License v1.0许可 .