git related fixes

{{cookiecutter.repo_name}}/.gitignore

@@ -38,7 +38,17 @@ htmlcov
 *.pot
 
 # Pycharm
-.idea
+.idea/*
+{% if cookiecutter.use_pycharm == 'y' %}
+# Provided default Pycharm Run/Debug Configurations should be tracked by git
+# In case of local modifications made by Pycharm, use update-index command
+# for each changed file, like this:
+# git update-index --assume-unchanged .idea/{{cookiecutter.repo_name}}.iml
+!.idea/runConfigurations/
+!.idea/{{cookiecutter.repo_name}}.iml
+!.idea/vcs.xml
+!.idea/webResources.xml
+{% endif %}
 
 # Vim
 

{{cookiecutter.repo_name}}/.idea/runConfigurations/Docker__migrate.xml

@@ -3,8 +3,8 @@
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
     <envs>
-      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
       <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
     </envs>
     <option name="SDK_HOME" value="docker-compose://$PROJECT_DIR$/dev.yml:pycharm/python" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />

{{cookiecutter.repo_name}}/.idea/runConfigurations/Docker__runserver.xml

@@ -3,8 +3,8 @@
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
     <envs>
-      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
       <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
     </envs>
     <option name="SDK_HOME" value="docker-compose://$PROJECT_DIR$/dev.yml:django/python" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />

{{cookiecutter.repo_name}}/.idea/runConfigurations/Docker__runserver_plus.xml

@@ -3,8 +3,8 @@
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
     <envs>
-      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
       <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="DJANGO_SETTINGS_MODULE" value="config.settings.local" />
     </envs>
     <option name="SDK_HOME" value="docker-compose://$PROJECT_DIR$/dev.yml:django/python" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />

{{cookiecutter.repo_name}}/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

{{cookiecutter.repo_name}}/.idea/{{cookiecutter.repo_name}}.iml

@@ -14,6 +14,7 @@
     <content url="file://$MODULE_DIR$">
       <excludeFolder url="file://$MODULE_DIR$/node_modules" />
     </content>
+    <orderEntry type="sourceFolder" forTests="false" />
   </component>
   <component name="PackageRequirementsSettings">
     <option name="requirementsPath" value="$MODULE_DIR$/requirements/local.txt" />
@@ -26,4 +27,8 @@
       </list>
     </option>
   </component>
+  <component name="TestRunnerService">
+    <option name="projectConfiguration" value="py.test" />
+    <option name="PROJECT_TEST_RUNNER" value="py.test" />
+  </component>
 </module>

{{cookiecutter.repo_name}}/docs/pycharm/configuration.rst

@@ -60,3 +60,13 @@ Known issues
 .. image:: images/issue1.png
 
 This might be fault of your firewall. Take a look on this ticket - https://youtrack.jetbrains.com/issue/PY-18913
+
+* Modified files in `.idea` directory
+
+Most of the files from `.idea/` were added to `.gitignore` with a few exceptions, which were made, to provide "ready to go" configuration. After adding remote interpreter some of these files are altered by PyCharm:
+
+.. image:: images/issue2.png
+
+In theory you can remove them from repository, but then, other people will lose a ability to initialize a project from provided configurations as you did. To get rid of this annoying state, you can run command::
+
+    $ git update-index --assume-unchanged {{cookiecutter.repo_name}}.iml