Skip to content

Commit d9f72f9

Browse files
author
Nic Wortel
committed
Some refactoring of the article
Shorten the 2nd list item a bit, and move it into a 'Tip' seems to make more sense.
1 parent 083c1f5 commit d9f72f9

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

cookbook/workflow/new_project_git.rst

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,27 +30,6 @@ git repository:
3030
required vendor libraries. For more information about downloading Symfony using
3131
Composer, see `Installing Symfony using Composer`_.
3232

33-
#. Your project folder will now contain files for your new project, as well
34-
as files and folders for vendor libraries. You'll want to store your project
35-
files in Git, but not the dependencies, since they will be managed by Composer.
36-
You'll also want to keep your ``parameters.yml`` out of your repository as it will
37-
contain sensitive information, such as database credentials. Furthermore,
38-
files that are automatically created by Symfony (such as logs, caches, and dumped
39-
assets) should be excluded as well.
40-
41-
To help you keep these files out of your repository, Symfony comes with a file
42-
called ``.gitignore``. It contains a list of files and folders that Git will
43-
ignore.
44-
45-
The contents of the ``.gitignore`` file that comes with the Standard Distribution
46-
can be found in the `GitHub repository`_.
47-
48-
.. tip::
49-
50-
You may also want to create a .gitignore file that can be used system-wide,
51-
in which case, you can find more information here: `Github .gitignore`_
52-
This way you can exclude files/folders often used by your IDE for all of your projects.
53-
5433
#. Initialize your Git repository:
5534

5635
.. code-block:: bash
@@ -63,6 +42,23 @@ git repository:
6342
6443
$ git add .
6544
45+
.. tip::
46+
47+
As you might have noticed, not all files that were downloaded by Composer in step 1,
48+
have been staged for commit by Git. Certain files and folders, such as the project's
49+
dependencies (which are managed by Composer), ``parameters.yml`` (which contains sensitive
50+
information such as database credentials) and log-, cache- and asset files (which are
51+
created automatically by your project), should not be committed in Git. To help you prevent
52+
committing those files and folders by accident, the Standard Distribution comes with a
53+
file called ``.gitignore``, which contains a list of files and folders that Git should
54+
ignore.
55+
56+
.. tip::
57+
58+
You may also want to create a .gitignore file that can be used system-wide,
59+
in which case, you can find more information here: `Github .gitignore`_
60+
This way you can exclude files/folders often used by your IDE for all of your projects.
61+
6662
#. Create an initial commit with your started project:
6763

6864
.. code-block:: bash
@@ -116,7 +112,6 @@ manage this is `Gitolite`_.
116112
.. _`Git`: http://git-scm.com/
117113
.. _`Symfony2 Standard Edition`: http://symfony.com/download
118114
.. _`Installing Symfony using Composer`: http://symfony.com/doc/current/book/installation.html#option-1-composer
119-
.. _`GitHub repository`: https://github.com/symfony/symfony-standard/blob/master/.gitignore
120115
.. _`git submodules`: http://git-scm.com/book/en/Git-Tools-Submodules
121116
.. _`GitHub`: https://github.com/
122117
.. _`barebones repository`: http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository

0 commit comments

Comments
 (0)