From a027e27018f72034c20735a54f772dcf995940ae Mon Sep 17 00:00:00 2001 From: labuladong Date: Sun, 19 Mar 2023 17:16:54 +0800 Subject: [PATCH] add contribution guide --- .github/PULL_REQUEST_TEMPLATE.md | 12 +++- .../contribution-guide.md" | 70 +++++++++++++++++++ ...56\345\244\215\346\214\207\345\215\227.md" | 60 ---------------- 3 files changed, 80 insertions(+), 62 deletions(-) create mode 100644 "\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/contribution-guide.md" delete mode 100644 "\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/\344\277\256\345\244\215\346\214\207\345\215\227.md" diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 334bf15..59f95ce 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,13 @@ - --> \ No newline at end of file +我修改的是如下题目的 xx 解法： + + + +通过截图如下： + + \ No newline at end of file diff --git "a/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/contribution-guide.md" "b/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/contribution-guide.md" new file mode 100644 index 0000000..e1c5ae6 --- /dev/null +++ "b/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/contribution-guide.md" @@ -0,0 +1,70 @@ +# 修正 labuladong 刷题插件中的错误 + +## 背景 + +为了帮助大家更好地学习算法，我之前写了很多算法教程，并开发了一系列刷题插件，统称为《labuladong 的刷题全家桶》，详情见 [这里](https://labuladong.github.io/article/fname.html?fname=全家桶简介)。 + +在我的教程和插件中的解法主要使用的是 Java 语言，原因是 Java 这门语言中规中矩，就算之前没有接触过，也能比较容易看懂逻辑。不过现在这不是 chatGPT 横空出世了嘛，我就借助 chatGPT 把我的解法改写成多种语言，希望对不同技术背景的小伙伴更加友好。 + +chatGPT 的改写效果还是非常不错的，不过难免还是存在一些错误，所以我希望能够和大家一起来修正这些错误。 + +## 如何修正错误 + +首先，感谢你愿意为我的插件提供的解法代码纠错，你向本仓库提交 PR 修复错误后，你将成为本仓库的 contributor，出现在仓库首页的贡献者列表中。本仓库已经获得了 115k star，你的贡献将会被许多人看到。 + +修复代码很简单，所有多语言解法代码都存储在 [多语言解法代码/solution_code.md](https://github.com/labuladong/fucking-algorithm/blob/master/%E5%A4%9A%E8%AF%AD%E8%A8%80%E8%A7%A3%E6%B3%95%E4%BB%A3%E7%A0%81/solution_code.md) 中，你只要修改这个文件就行了。其内容的组织形如如下： + + + https://leetcode.cn/problems/xxx 的多语言解法👇 + + ```cpp + class Solution { + public: + int xxx() { + // ... + } + }; + ``` + + ```java + class Solution { + public int xxx() { + // ... + } + } + ``` + + ```python + class Solution: + def xxx(self): + # ... + ``` + + ```javascript + var xxx = function() { + // ... + } + ``` + + ```go + func xxx() { + // ... + } + ``` + + https://leetcode.cn/problems/xxx 的多语言解法👆 + + +比如你想修改 [https://leetcode-cn.com/problems/longest-palindromic-substring/](https://leetcode-cn.com/problems/longest-palindromic-substring/) 的 JavaScript 解法，你可以在 [多语言解法代码/solution_code.md](https://github.com/labuladong/fucking-algorithm/blob/master/%E5%A4%9A%E8%AF%AD%E8%A8%80%E8%A7%A3%E6%B3%95%E4%BB%A3%E7%A0%81/solution_code.md) 中搜索 `longest-palindromic-substring` 关键词，即可找到这道题的多语言解法，然后修改 JavaScript 对应的解法代码，提交 PR 即可。 + +我的插件会自动拉取这个文件的最新内容，所以你的 PR 被合进 master 分支后，插件中的内容修改也会生效。 + +## 提交 PR 的要求 + +1、你的 PR 必须是针对 [多语言解法代码/solution_code.md](https://github.com/labuladong/fucking-algorithm/blob/master/%E5%A4%9A%E8%AF%AD%E8%A8%80%E8%A7%A3%E6%B3%95%E4%BB%A3%E7%A0%81/solution_code.md) 文件中代码部分的修改，不要修改其他文件和其他内容。 + +2、把我的解法翻译成多语言的目的是帮助不同背景的小伙伴理解算法思维，所以你修改的代码可以不是效率最优的，但应该尽可能和我的解法思路保持一致，且包含我的解法中的完整注释。 + +3、你的 PR 描述中需要包含代码通过所有测试用例截图。 + +**你可以查看这个 PR 作为案例**：https://github.com/labuladong/fucking-algorithm/pull/1112 \ No newline at end of file diff --git "a/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/\344\277\256\345\244\215\346\214\207\345\215\227.md" "b/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/\344\277\256\345\244\215\346\214\207\345\215\227.md" deleted file mode 100644 index 72149b6..0000000 --- "a/\345\244\232\350\257\255\350\250\200\350\247\243\346\263\225\344\273\243\347\240\201/\344\277\256\345\244\215\346\214\207\345\215\227.md" +++ /dev/null @@ -1,60 +0,0 @@ -# 修正 labuladong 刷题插件中的错误 - -首先，感谢你愿意为我的插件提供的解法代码纠错，你按照下面的步骤提交 PR 修复错误后，你将成为本仓库的 contributor，出现在仓库首页的贡献者列表中。本仓库已经获得了 115k+ star，你的贡献将会被许多人看到。 - -修复代码很简单，所有多语言解法代码都存储在 [solution_code.md](./solution_code.md) 中，你只要修改这个文件就行了。其内容的组织形如如下： - - - https://leetcode.cn/problems/xxx 的多语言解法👇 - - ```cpp - class Solution { - public: - int xxx() { - // ... - } - }; - ``` - - ```java - class Solution { - public int xxx() { - // ... - } - } - ``` - - ```python - class Solution: - def xxx(self): - # ... - ``` - - ```javascript - var xxx = function() { - // ... - } - ``` - - ```go - func xxx() { - // ... - } - ``` - - https://leetcode.cn/problems/xxx 的多语言解法👆 - - -比如你想修改 [https://leetcode-cn.com/problems/longest-palindromic-substring/](https://leetcode-cn.com/problems/longest-palindromic-substring/) 的多语言解法，你可以在 [solution_code.md](./solution_code.md) 中搜索 `longest-palindromic-substring`，即可找到这道题的多语言解法，然后修改这个文件，提交 PR 即可。 - -我的插件会自动拉取这个文件的最新内容，所以你的 PR 被合进 master 分支后，插件中的内容修改也会生效。 - -## 提交 PR 的要求 - -1、你的 PR 必须是针对 [solution_code.md](./solution_code.md) 文件中代码部分的修改，不要修改其他文件和其他内容。 - -2、把我的解法翻译成多语言的目的是帮助不同背景的小伙伴理解算法思维，所以你修改的代码可以不是效率最优的，但应该尽可能和我的解法思路保持一致，且包含我的解法中的完整注释。 - -3、你的 PR 需要包含截图，截图中必须包含你修改的代码在 leetcode-cn.com 上的运行结果，否则 PR 会被拒绝。 - -以上几点 \ No newline at end of file -- GitLab