oh-my-bash icon indicating copy to clipboard operation
oh-my-bash copied to clipboard

Document naming convention #280 in CONTRIBUTING.md

Open akinomyoga opened this issue 1 year ago • 0 comments

[...] the variables for plugins are supposed to have the name of OMB_PLUGIN_{PluginName}_{ConfigName} (see the xterm and fasd plugins for examples). We do not include the variables for specific plugins in the bashrc template by default, but instead, describe the usage in the README of each plugin to let the user add it in their bashrc by themselves.

This is valuable information that can be added to CONTRIBUTING.md!

Originally posted by @sanzoghenzo in https://github.com/ohmybash/oh-my-bash/issues/371#issuecomment-1326103570


This is valuable information that can be added to CONTRIBUTING.md!

Thank you for the suggestion! Actually, the convention of OMB_THEME_{plugin}_{config} is a part of a proposal in Discussion #280. There seem to be no further opinions on the proposal, so I guess we can now freeze the convention and put it somewhere in the documents. The current content of CONTRIBUTING.md is the one inherited from the upstream oh-my-zsh. I actually think that we need to do an overhaul of CONTRIBUTING.md at some point, but incremental fixes are also welcome. By the way, there is also a PR on CONTRIBUTING.md at #90, but I don't see reasons for large changes in #90 so currently am leaving it as is.

Originally posted by @akinomyoga in https://github.com/ohmybash/oh-my-bash/issues/371#issuecomment-1326128228

akinomyoga avatar Dec 04 '22 22:12 akinomyoga