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

Remove .config Directory from Repository #3

Open
3 tasks
thomasvincent opened this issue Apr 22, 2024 · 0 comments
Open
3 tasks

Remove .config Directory from Repository #3

thomasvincent opened this issue Apr 22, 2024 · 0 comments
Assignees
Labels
bug Bug or issue

Comments

@thomasvincent
Copy link
Owner

Description

The .config directory currently exists in the repository, which may contain configuration files that are not universally applicable or necessary for all users. The proposal is to review and possibly remove this directory to streamline the repository's contents.

Rationale

  • Simplify Repository: Removing potentially unnecessary or user-specific configurations can help simplify the management of the repository.
  • Security and Privacy: Ensure that no sensitive or personal configuration data is exposed in a public repository.
  • Relevance: Assess if the configurations within the .config directory are essential for the repository's intended use.

Tasks

  • Review the contents of the .config directory to determine the necessity and relevance of the files.
  • If decided to remove:
    • Delete the .config directory from the repository.
    • Update the .gitignore to prevent future tracking of the .config directory.
    • Commit these changes with a clear and descriptive message.
    • Push the changes to ensure the directory is removed from remote repository.
  • Document the changes and reasoning in the project's main documentation or README.md.

Acceptance Criteria

  • The .config directory is properly reviewed and either retained with justification or removed entirely.
  • The repository functions as expected without the .config directory if removed.
  • Documentation is updated to reflect the change.

Additional Notes

  • This task may require coordination with other contributors to ensure no critical functionality is lost.
  • Double-check all dependencies and paths referenced in scripts or documentation to ensure they do not rely on configurations from the .config directory.
@thomasvincent thomasvincent added the bug Bug or issue label Apr 22, 2024
@thomasvincent thomasvincent self-assigned this Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug or issue
Projects
None yet
Development

No branches or pull requests

1 participant