Deploying to gh-pages from @ Klipper3d/klipper@b1f597c550 🚀

This commit is contained in:
KevinOConnor
2023-10-18 00:04:00 +00:00
parent e8ff475d4f
commit 091eb8035f
27 changed files with 355 additions and 354 deletions

View File

@@ -1449,7 +1449,7 @@
<p>All new modules, config options, commands, command parameters, and documents should have "high impact". We do not want to burden users with options that they can not reasonably configure nor do we want to burden them with options that don't provide a notable benefit.</p>
<p>评审员可能会要求解释用户该如何配置一个选项,一个理想的答复将包含过程的细节,例如:"MegaX500的用户应将选项 X 设置为99.3而Elite100Y的用户应使用程序校准选项X..." 。</p>
<p>如果一个选项的目标是使代码更加模块化,那么最好使用代码常量而不是向用户开放的配置选项。</p>
<p>New modules, new options, and new parameters should not provide similar functionality to existing modules - if the differences are arbitrary than it's preferable to utilize the existing system or refactor the existing code.</p>
<p>新模块、新选项和新参数不应提供与现有模块类似的功能——如果差异是任意的,那么最好利用现有系统或重构现有代码。</p>
</li>
<li>
<p>提交的版权是否清晰、无偿、兼容?新的 C 文件和 Python 文件应该有一个明确的版权声明。请看现有文件以了解推荐格式。不推荐在对现有文件进行小的修改时对该文件进行版权声明。</p>
@@ -1479,8 +1479,8 @@
<p>空格的修改不应该与功能修改混在一起。一般来说,无意义的空格修改是不被接受的,除非是来自被修改代码的既定 "所有者"。</p>
</li>
</ol>
<p>Klipper does not implement a strict "coding style guide", but modifications to existing code should follow the high-level code flow, code indentation style, and format of that existing code. Submissions of new modules and systems have more flexibility in coding style, but it is preferable for that new code to follow an internally consistent style and to generally follow industry wide coding norms.</p>
<p>It is not a goal of a review to discuss "better implementations". However, if a reviewer struggles to understand the implementation of a submission, then they may ask for changes to make the implementation more transparent. In particular, if reviewers can not convince themselves that a submission is free of defects then changes may be necessary.</p>
<p>Klipper没有实现严格的“编码风格指南”,但对现有代码的修改应该遵循高级代码流、代码缩进风格和现有代码的格式。新模块和系统的提交在编码风格上具有更大的灵活性,但新代码最好遵循内部一致的风格,并通常遵循行业范围的编码规范。</p>
<p>讨论“更好的实现”并不是审查的目标。然而,如果审查人员很难理解提交的实现,那么他们可能会要求进行更改,以使实现更加透明。特别是,如果评审员不能说服自己提交的文件没有缺陷,那么可能需要进行更改。</p>
<p>As part of a review, a reviewer may create an alternate Pull Request for a topic. This may be done to avoid excessive "back and forth" on minor procedural items and thus streamline the submission process. It may also be done because the discussion inspires a reviewer to build an alternative implementation. Both situations are a normal result of a review and should not be considered criticism of the original submission.</p>
<h3 id="helping-with-reviews">Helping with reviews<a class="headerlink" href="#helping-with-reviews" title="Permanent link">&para;</a></h3>
<p>We appreciate help with reviews! It is not necessary to be a <a href="#reviewers">listed reviewer</a> to perform a review. Submitters of GitHub Pull Requests are also encouraged to review their own submissions.</p>