Blob and tree gfm links to anchors work.

Fixes #6046

1 files changed, 10 insertions, 0 deletions

diff --git a/spec/factories.rb b/spec/factories.rb
index 37436e53b95..7fc2b7c5e97 100644
--- a/spec/factories.rb
+++ b/spec/factories.rb
@@ -34,6 +34,16 @@ FactoryGirl.define do
     creator
   end
 
+  # Generates a test repository from the repository stored under `spec/seed_project.tar.gz`.
+  # Once you run `rake gitlab:setup`, you can see what the repository looks like under `tmp/repositories/gitlabhq`.
+  # In order to modify files in the repository, you must untar the seed, modify and remake the tar.
+  # Before recompressing, do not forget to `git checkout master`.
+  # After recompressing, you need to run `RAILS_ENV=test bundle exec rake gitlab:setup` to regenerate the seeds under tmp.
+  #
+  # If you want to modify the repository only for an specific type of tests, e.g., markdown tests,
+  # consider using a feature branch to reduce the chances of collision with other tests.
+  # Create a new commit, and use the same commit message that you will use for the change in the main repo.
+  # Changing the commig message and SHA of branch `master` may break tests.
   factory :project, parent: :empty_project do
     path { 'gitlabhq' }