Skip to content

Update .gitignore to exclude unnecessary files #898

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.

Sign up for GitHub

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

Closed
mahdirahimi1999 wants to merge 2 commits into from
Closed

Update .gitignore to exclude unnecessary files #898

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
640dc59
Fix: Update .gitignore to exclude unnecessary files
mahdirahimi1999 Mar 28, 2025
b8df578
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,9 @@ dmypy.json

# Cython debug symbols
cython_debug/

# macOS system files
*.DS_Store

# Process ID files
Copy link
Copy Markdown
Member

@Andrew-Chen-Wang Andrew-Chen-Wang Apr 10, 2025

Choose a reason for hiding this comment

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

why is this needed

Copy link
Copy Markdown
Member Author

@mahdirahimi1999 mahdirahimi1999 Apr 10, 2025

Choose a reason for hiding this comment

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

.DS_Store means Desktop Services Store. It's a hidden file that macOS creates in folders to save things like icon position, window size, and folder layout.

We add *.DS_Store to .gitignore because:

  • It's not part of the code.
  • It can be accidentally committed by macOS users.
  • It adds unnecessary files to the project.
  • It's not useful for people using Windows or Linux.
  • macOS creates this file automatically when someone opens a folder, so it might get added without them noticing.

Copy link
Copy Markdown
Member Author

@mahdirahimi1999 mahdirahimi1999 Apr 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

.pid files store the Process ID of a running service or application (like a web server or background worker like celery). These files are temporary, system-specific, and should not be tracked in version control.

✅ Ignoring both helps keep the repository clean and free from unnecessary or machine-specific files.

Copy link
Copy Markdown
Member Author

@mahdirahimi1999 mahdirahimi1999 Apr 10, 2025

Choose a reason for hiding this comment

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

@Andrew-Chen-Wang

Copy link
Copy Markdown
Member

@Andrew-Chen-Wang Andrew-Chen-Wang Apr 10, 2025

Choose a reason for hiding this comment

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

I meant specifically PID. Where in this repository are we generating PID files? Seems unnecessary

Copy link
Copy Markdown
Member Author

@mahdirahimi1999 mahdirahimi1999 Apr 10, 2025

Choose a reason for hiding this comment

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

You're right, and I agree that adding *.pid is unnecessary. However, I wanted to point out that celerybeat.pid is already included in the .gitignore file under the Celery stuff section.

*.pid
Loading