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

Readme: Clarify CONFIG_DIR and recommend copy of config template #379

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

inkarkat
Copy link
Member

  • Fork the repository and create your branch from master.
  • [-] If you've added code that should be tested, add tests!
  • [-] Ensure the test suite passes.
  • [-] Format your code with ShellCheck.
  • Include a human-readable description of what the pull request is trying to accomplish.
  • [-] Steps for the reviewer(s) on how they can manually QA the changes.
  • Have a fixes #XX reference to the issue that this pull request fixes.

Documentation: Clarify that CONFIG_DIR is for the configuration template, not meant as the configuration to use

Add a Configuration section (between Installing and Usage) with overview and recommendation to copy the template.

Fixes #377

And only coincidentally picked up as the global configuration (if CONFIG_DIR=/etc).

Fixes todotxt#377
@inkarkat inkarkat changed the title **Before submitting a pull request,** please make sure the following is done: Readme: Clarify CONFIG_DIR and recommend copy of config template Mar 28, 2022
@inkarkat inkarkat requested a review from karbassi March 28, 2022 20:33
@inkarkat
Copy link
Member Author

inkarkat commented Jul 4, 2022

@karbassi Another user got confused here; could you please merge this really soon?! I haven't heard from you in a while; is everything alright? If you don't have any time for the project right now, I could merge my own pending PRs (and some other simple ones) to reduce the backlog.

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.

todo.sh doesn't know about CONFIG_DIR
1 participant