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

Add git maintenance files #74

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ace-dent
Copy link
Contributor

@ace-dent ace-dent commented Jan 8, 2023

Changes to make external contributions easier:

  • Extend .gitignore for OS files (easier for new contributors).
  • Add .gitattributes to normalize line endings.
  • Bonus: Update Copyright year.

@MLXXXp
Copy link
Owner

MLXXXp commented Jan 8, 2023

I'll consider adding the .gitattributes file, after researching it a bit.

However, I don't want to put anything in .gitignore that pertains to a specific O/S or editor. I feel those should remain as global or working directory settings on the user's own system.

@ace-dent
Copy link
Contributor Author

ace-dent commented Jan 9, 2023

The .gitignore literally ignores those files on one's local copy. It just means they won't be accidentally committed. It also avoids any committer needing to remove them (locally) when preparing a commit. This stuff is just a nice Quality of Life touch for external contributors. :-D

@MLXXXp
Copy link
Owner

MLXXXp commented Jan 10, 2023

But where does it end?

I use Linux and my editor adds a ~ to the end of a filename to create a backup. Other editors might use a .BAK extension. Someday, another OS might be supported by Arduino, which has its own local files that should be ignored. People might use an IDE that can compile for Arduino, which has it's own specific config files, etc. in its local working directories.

I don't want to have to keep extending the library's .gitignore every time a new possibility arises. External contributors are expected learn Git well enough to maintain their own .gitignore file(s) as required by them.

Plus, it's better that the filenames you've included be added to the user's global .gitignore_global file, since it's very likely they should be ignored for all projects using Git.

- Add `.gitattributes` to normalize line endings.
- Bonus: Update Copyright year.
@ace-dent
Copy link
Contributor Author

ace-dent commented Jan 11, 2023

Thanks @MLXXXp for feedback. After ~decade of using Git, I didn't know this could be set globally! ...You don't know, what you don't know!... I have removed the .gitignore changes.

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.

2 participants