This document discusses IDE meta files, which store project configuration data. It notes debates around whether to commit these files to version control. While some argue they are environment-specific, the presenter claims meta files can be shared across IDEs and versions. The document advises committing meta files to enable code style standardization, onboarding new contributors, and long-term support. It surveys the practices and recommendations for specific IDEs like IntelliJ, Xcode, and Eclipse.

1. Committing IDE meta files:
misconceptions,
misunderstandings,
and solutions.
Aurelien Pupier - @apupier
Studio Development Leader
© 2015 Bonitasoft 2

2. IDE Meta files: what?
Storage of data describing a
project/module
3© 2015 Bonitasoft

3. IDE Meta files: what for?
For the best development Experience
4© 2015 Bonitasoft

4. IDE Meta files: what for in details?
• Checkstyle & code conventions
• Specify toolchain
• Commit message format
• And more!
5© 2015 Bonitasoft

5. IDE Meta files advantages
• Share common configuration within team
• Help newcomers
• Help casual contributors
• LTS
6© 2015 Bonitasoft

6. IDEs tour:
Commit or not recommendation
7© 2015 Bonitasoft

7. IntelliJ IDEA
• article
– Commits .idea (replacing .iml and .ipr)
8© 2015 Bonitasoft

8. • documentation
– “folders should not be checked into that version control
system.”
– “nbproject should be checked into the version control
system”
9© 2015 Bonitasoft

9. XCode
• answer
–.xccheckout  to commit
–.xcuserdata  not to commit
10© 2015 Bonitasoft

10. •Unity official documentation:
–“When checking the project into a
version control system, you should add
the Assets and
the ProjectSettings directories to the
system.”
11© 2015 Bonitasoft

11. Eclipse
• Eclipse forum answer
• blog article from an Eclipse trainer
–.project
–.settings/
–.classpath
12© 2015 Bonitasoft

12. Why don’t you want to commit?
13© 2015 Bonitasoft

13. Heard arguments to not commit (1/4)
• Relative to an environment
– Several years ago yes
• Never encountered, I’m lucky or too young
• Found 2004 detailed report
– Very specific use cases:
• use IDE variables
14© 2015 Bonitasoft

14. Heard arguments to not commit (2/4)
• Pollutes other IDEs:
– Hide files
15© 2015 Bonitasoft

15. Heard arguments to not commit (3/4)
• Locked to a specific IDE:
– You’re not!
– Hide files
16© 2015 Bonitasoft

16. Heard arguments to not commit (4/4)
• Different IDE versions across team:
– Works like a charm for years for us with Eclipse
17© 2015 Bonitasoft

17. If you (and he/she) loose
18© 2015 Bonitasoft

18. Visit us online
bonitasoft.com
Join our community
Bonitasoft.org
Download
Bonitasoft.com/downloads
Follow us on twitter
@bonitasoft
Convince & Commit
(and Report/Contribute)
@apupier
© 2015 Bonitasoft 19

19. 20© 2015 Bonitasoft