Skip to content

Clarify config usage: rename config.json to config.json.template and ignore actual config.json - #59

Merged
aaronbrethorst merged 3 commits into
OneBusAway:mainfrom
0xaboomar:main
Jun 10, 2025
Merged

aaronbrethorst merged 3 commits into
OneBusAway:mainfrom
0xaboomar:main

Conversation

@0xaboomar

Copy link
Copy Markdown
Member
  • Renamed config.json to config.json.template to explicitly communicate that the file contains example configuration data meant to be copied and customized by users.
  • Stopped tracking config.json in Git by removing it from the index to prevent accidental commits of sensitive or local configuration.
  • Confirmed config.json is included in .gitignore to avoid future tracking by contributors.
  • Updated documentation with clear instructions on how to copy config.json.template to config.json and customize it for local use.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 75.109% (+0.3%) from 74.819%
when pulling 0e8ebfe on Abo-Omar-74:main
into b15bc12 on OneBusAway:main.

@aaronbrethorst aaronbrethorst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

@aaronbrethorst
aaronbrethorst merged commit eb2f748 into OneBusAway:main Jun 10, 2025
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.

3 participants