Perlwikibot/贡献

介绍

Perlwikibot 是一个开源项目，旨在创建一个完整的框架，以便快速创建和部署计算机程序，这些程序可以执行 MediaWiki 维基上的常见重复任务。这些客户端通常被称为“机器人” - 因此得名该项目。

您可以帮助修复错误或为框架添加新功能。代码是根据 GNU 通用公共许可证授权的。简而言之，这意味着任何人都可以将代码用于任何目的，包括商业用途，以及制作和分发修改后的版本，只要他们提供归属信息，并且所有派生版本也都在 GPL 下获得授权。

代码风格

Perl 代码本身就很难阅读，所以请努力编写可读的代码。

注释

无论何时代码执行了不明显的操作，都应包含注释。

不好

sub foo {
    my $param = shift; # Take the first param
    my @args = @_;     # Take the remaining elements, if any
}

很好

sub bar {
    my $param = shift; # The page to edit
    my @args  = @_;    # Contains any other settings (for example, whether to mark the edit as minor)
}

Perltidy

Perltidy 是一个代码缩进器和格式化程序。您可以使用它来帮助清理您的 Perl 代码。对于 perlwikibot，请使用

-syn    # Syntax check input and output
-b      # Backup and modify in-place
-l=78   # Max line width is 78 cols
-i=4    # Indent level is 4 cols
-ci=4   # Continuation indent is 4 cols
-vt=0   # Minimum vertical tightness
-vtc=0  # Minimum vertical tightness closing
-cti=0  # No extra indentation for closing brackets
-pt=2   # Maximum parenthesis tightness
-sbt=2  # Maximum square bracket tightness
-bt=1   # Medium brace tightness
-nsfs   # No space before semicolons
-nolq   # Don't outdent long quoted strings
-boc    # Break at old comma breakpoints
-bbs    # Blank line before subs
-sot    # Stack opening tokens
-sct    # Stack closing tokens
-bbao   # Break before all operators

您可以将它放在 .perltidyrc 中，它们将在每次使用 perltidy 时使用。将该文件放在您的工作目录中以仅应用于该目录，或者放在您的 $HOME 中以对所有内容使用这些设置。

或者，将每个选项设置为 perltidy 的命令行选项

user@host:~$ perltidy -syn -b -l=78 ...

提交

Mike 将他的 git 仓库推送到 github；要做出贡献，请创建一个分支，进行更改，并创建一个新的拉取请求。