DevKit updates (#21)

.gitattributes

@@ -0,0 +1,3 @@
+.* export-ignore
+*.md export-ignore
+Tests/* export-ignore

.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
 

.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

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.