Update instructions in CONTRIBUTING.md #54
Conversation
Codecov Report
@@ Coverage Diff @@
## master #54 +/- ##
=======================================
Coverage 47.81% 47.81%
=======================================
Files 72 72
Lines 2405 2405
=======================================
Hits 1150 1150
Misses 1255 1255Continue to review full report at Codecov.
|
Write value into DEBUG file. This is more in line with the module which amends the environment by reading values from files in the . removes environment variables if the corresponding file is empty
CONTRIBUTING.md
Outdated
| # Enable DEBUG (and development) mode | ||
| echo 1 > ~/.config/promgen/DEBUG | ||
| # Copy default settings (amend by hand after) | ||
| cp promgen/tests/examples/promgen.yml |
There was a problem hiding this comment.
This should be copied by bootstrap already, though perhaps I could have it automatically open up in $EDITOR if you thought that would be useful
There was a problem hiding this comment.
Thanks for the feedback! You're right, bootstrap will already have written a config file.
Do you know if there is a standard command on UNIX systems to start the default editor? I know debian provides editor which maps to nano, vim, emacs, ... but I'm not sure about other distributions.
There was a problem hiding this comment.
EDITOR is the one I have seen that is most common though sometimes I have seen VISUAL. Trying to find a more definitive source but it can be difficult with things like this :)
There was a problem hiding this comment.
Alright, perhaps a comment is more feasible than dissecting UNIX standard practices ;)
On my system $EDITOR is unset when starting the shell and the editor executable references nano.
There was a problem hiding this comment.
Yeah, it's just a random thought I had. Feel free to keep things simple :)
CONTRIBUTING.md
Outdated
| #### Custom Configuration Directory | ||
|
|
||
| By default `promgen` uses `~/.config/promgen` as its configuration directory. | ||
| This can be changed by setting the environment variable `CONFIG_DIR` to an alternative location whenever calling `promgen ...` commands. |
There was a problem hiding this comment.
Perhaps I should change this to PROMGEN_CONFIG? Any thoughts on that?
* Added note about default `admin` user * Removed unnecessary cp command * Env var `CONFIG_DIR` to `PROMGEN_CONFIG_DIR`
|
Hmm, not sure why I missed reviewing this again. I'll go ahead and merge this, and then update README to point to this file to avoid the duplicate content. Thank you :) |
This pull request updates the "Setting up Promgen for development" section in the CONTRIBUTING file.
I added some commands initialising the required settings and also switched from
virtualenvto thevenvmodule.