Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add some other solutions #710

Closed
wants to merge 1 commit into from
Closed

Conversation

KimYangOfCat
Copy link
Member

@KimYangOfCat KimYangOfCat commented Feb 11, 2022

关于项目,我有一些好奇的问题,期望得到熟悉项目的维护者的解答:
为什么 Soulution.* 各类代码文件中有多种解决方案,而 README.md 中却只写了一种方案?
且最终 docsify 也并没有解析 Soulution.* 各类代码文件,那这些文件的作用是什么?
是否可以考虑直接将 Soulution.* 各类代码文件的内容直接解析到对应的 README 文件中?

Copy link
Member

@yanglbme yanglbme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Solution.* 是各种题解的源代码文件,本项目要求单独保存每个源代码文件。
  • 由于历史原因,项目结构上做了非常大的变更,同时 Solution.* 部分代码相对比较陈旧、不规范,所以没有考虑直接将 Solution.* 所有代码解析至 README \ README_EN 中。不过随着项目的迭代,会完善起来的。
  • 每个 commit 不添加 author,git commit history 已经体现出来了,如果每个人提交一点代码都要写上一个 author,会很混乱。
  • 新增加的代码题解,格式也有比较严格的要求,提交之前需要先 format。

@yanglbme
Copy link
Member

yanglbme commented Feb 11, 2022

目前项目倾向于在 README 中写多种解法(可以是同一种语言的多种解法),而 Solution.* 每个文件中,只保留一种比较合适的解法。所以如果你想新增一种解法,可以在 README.md 和 README_EN.md 文件中同时添加代码题解,Solution.* 可以不更改。

@yanglbme
Copy link
Member

这个 pr 我先关闭,不过有问题可以继续在这个 pr 上沟通。欢迎你来参与项目。

@yanglbme yanglbme closed this Feb 11, 2022
@KimYangOfCat
Copy link
Member Author

非常感谢你的解答,明白了!
不过还是想提一点儿小小的意见:
是否可以考虑开启项目的 wiki 功能,并在其中简单描述一下项目情况,以及当前推荐的合作方式,以及新增解法的推荐做法,这样或许对新加入的同学友好一点儿,方便上手?也避免其他新同学像我这样参考了过时的做法,而导致提交无效的PR。

@yanglbme
Copy link
Member

详细的贡献指南确实很有必要,可以减少很多的沟通成本,这一部分在我们项目里还没完善,后续会做补充。

wiki 可能先不开启。项目的描述,合作方式等等,可以放到项目文件 guideline 中,也可以放在 Discussions 讨论区中。同时 pull request template 也可以用起来。

@yanglbme
Copy link
Member

欢迎你来参与项目。代码提交相关,你也可以参考此前被 merge 的 pr。

@KimYangOfCat
Copy link
Member Author

欢迎你来参与项目。代码提交相关,你也可以参考此前被 merge 的 pr。

感谢,期待新的 guideline ,已重新提交 PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants