如何在Github分享自己的Emacs配置

·  阅读 419

在这里,我并不会讲述Github的使用方法,而是分享一下自己对分享一个什么样的配置的理解。

明确自己的配置的定位

现在有大量的配置在网络上被分享出来,这些配置五花八门,使用的插件琳琅满目,而且不同的配置编写的思路也大同小异。所以如何让别人一眼就能明白,你的配置是自己喜欢或者不喜欢的,很重要。我的建议是,在README中清楚的写出来你的配置的特点,以及你认为可能吸引人或者与众不同的地方。

尽可能只分享那些公共以及最简洁的部分

所有的配置,包括我的,都应该包含两部分:1)公共对外公开的部分;2)自己特有的个性化的部分。

我们应该公开分享的是第一部分,而第二部分我们不应该分享出来。因为这样的部分见仁见智,分享出来可能会引起很大的争议,甚至给使用者带来修改的难度与时间消耗。

例如,标题栏的格式,我喜欢只保留文件的名称,但这显然不适合于所有人,所以,这样的配置内容应该写到一个特定的文件中,然后在custom文件中进行引入,而该文件连同custom文件不该被纳入git的管理中。

甚至,一些平台特殊的配置也是可以写入到特定的个性化文件中的。

但,注意:如果不带有个性化,而是为了解决一些特定的问题,即使跨平台的配置,我们也不该放到个性化配置中。因为它是解决问题的,这样的问题其他人同样也会碰到。

注意在注释中给出解决方案的来源

这样的建议主要是考虑到,同样的问题同样的解决思路,可能在不同代码能力的人那里会产生不同的代码效果。所以,保留来源(链接等可跳转的参考文档)是有必要的。保留承认自己代码不够完美的余地,给高手留一点赐教的可能。

此外,还会尊重版权与原作者。

不做或少做不兼容的配置

除非特殊原因,或者添加了足够的提示,否则轻易不要做一些不兼容历史版本的变更。我自己在这方面就犯过这样的错误。一开始的时候,我绑定了大量的快捷按键,但后来越来越多的人给我反馈说,有按键的冲突——在各种你可能想象不到的场景中。

然后,我需要去考虑这样的场景,而不得不删除掉这些按键绑定。这样的改动给已经在使用我的配置的人带来了困扰。甚至,有的时候也给我自己带来了困扰——因为我自己也已经习惯了一些快捷键的绑定了。

把Emacs内置功能与第三方包分开配置

我说不好这样做是否很优雅,但我还是推荐这么做。因为这样可能会让使用者很容易地去理解和修改。大部分的时候,我们可能会在第三方包的使用上有不同的理解和使用习惯,但在内置的功能上,大家普遍都接受(毕竟少安装一些第三方包),所以隔离开来,对于个性化的修改非常有优势。

一段时间以来的一些思考和整理,后续继续分享更多的思路和成长经历。感谢阅读!

分类:
开发工具
标签:
分类:
开发工具
标签:
收藏成功!
已添加到「」, 点击更改