What should be .gitignored?

[traviswimer]

There are a lot of files generated by cocos2d-x that in general one would want to exclude from version control in their project, but it is really hard to know which files those are. This means any time you build your project there can be hundreds of generated files to check in, and it becomes very confusing. Not to mention, it can cause issues if developing in multiple environments. (http://stackoverflow.com/questions/36928128/compiling-cocos2d-x-project-on-both-linux-and-osx)

One of the great things about cocos2d-x is that you don't necessarily need to have a deep understanding of iOS/Android development. Unfortunately, if you don't understand what all the files and directories are for, it is very difficult to know what can be excluded.

In my opinion it would be great if a .gitignore file was generated when creating a new cocos project, as I assume a large majority of developers are using git as their VCS. Would this be possible?

If not, it would be great if there was at least a list somewhere in the documentation of all the files that should be excluded from version control.

[Alireza-Ashayer]

You can use .gitignore file inside cocos2d-x root directory. It covers almost all build artifacts that should not be in your version control system.

[traviswimer]

Thanks for the reply. What you said appears to be partially correct. I'm not sure if it includes a lot of the android files though. Also, most of the files/directories in the .gitignore are specific to this repo and irrelevant to an actual cocos2d-x project.

Although this is helpful, I wouldn't really call it a solution. I still think it would be very beneficial to have an officially supported list of files to exclude.

[Rubonnek]

I'm probably missing some files that should not be ignored, but here's the .gitignore I use for all my new cocos2d-x projects:

# Ignore everything under this directory
*

# But not these files:
!/.gitignore
!/Classes/**/*
!/Resources/**/*
!/CMakeLists.txt
!/proj.android/jni/Android.mk
!/proj.android/jni/Application.mk
!/proj.android/AndroidManifest.xml
!/proj.android/src/org/cocos2dx/cpp/AppActivity.java
!/proj.android-studio/build.gradle
!/proj.win32/*.sln
!/proj.win32/*.vcxproj*
!/proj.win8.1-universal/*.sln
!/proj.win10/*.sln
!/proj.ios_mac/*.xcodeproj/project.pbxproj

# Even if any of the above files are in subdirectories
!*/