From b038ad518124d7ce2679b9b330edf87ad8da7bb7 Mon Sep 17 00:00:00 2001
From: Sonata CI <thomas+ci@sonata-project.org>
Date: Thu, 24 Nov 2016 02:10:04 +0100
Subject: [PATCH] DevKit updates (#21)

---
 .gitattributes                   |  3 +++
 .github/PULL_REQUEST_TEMPLATE.md |  7 +++----
 .travis/install_docs.sh          |  2 +-
 CONTRIBUTING.md                  | 15 +++++++++++++++
 4 files changed, 22 insertions(+), 5 deletions(-)
 create mode 100644 .gitattributes

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 00000000..3edeb7c2
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,3 @@
+.* export-ignore
+*.md export-ignore
+Tests/* export-ignore
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 57df5e58..e1cebecc 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,4 @@
-<!-- THE PR TEMPLATE IS NOT AN OPTION. DO NOT DELETE IT! -->
+<!-- THE PR TEMPLATE IS NOT AN OPTION. DO NOT DELETE IT, MAKE SURE YOU READ AND EDIT IT! -->
 
 <!--
     Show us you choose the right branch.
@@ -7,15 +7,14 @@
     - master is for deprecation removals and other changes that cannot be done without a BC-break
     More details here: https://github.com/sonata-project/SonataArticleBundle/blob/master/CONTRIBUTING.md#the-base-branch
 -->
-I am targetting this branch, because…
+I am targetting this branch, because {reason}.
 
 <!--
     Specify which issues will be fixed/closed.
     Remove it if this is not related.
 -->
 
-Closes #
-Fixes #
+Closes #{put_issue_number_here}
 
 ## Changelog
 
diff --git a/.travis/install_docs.sh b/.travis/install_docs.sh
index e638352b..362f6449 100755
--- a/.travis/install_docs.sh
+++ b/.travis/install_docs.sh
@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 set -ev
 
-pip install -r Resources/doc/requirements.txt --user $(whoami)
+pip install -r Resources/doc/requirements.txt --user
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b492c440..06f6e596 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -208,6 +208,21 @@ if (/* some condition showing the user is using the legacy way */) {
 }
 ```
 
+Additionally, and when applicable, you must use the `@deprecated` tag on classes or methods you wish to deprecate,
+along with a message directed at the end user (as opposed to other contributors).
+
+
+```php
+/**
+ * NEXT_MAJOR: remove this method
+ *
+ * @deprecated since 3.x, to be removed in 4.0. Use Foo::bar instead.
+ */
+public function baz()
+{
+}
+```
+
 In that case, unit tests might show your deprecation notice. You must mark such tests with the `@group legacy` annotation,
 and if need be, isolate them in a new test method that can simply be removed in the non-BC PR.