Update CONTRIBUTING.md

Adding some more info for contributors
pytorch · May 6, 2022 · f0d7e1c · f0d7e1c
1 parent 0dc09f9
commit f0d7e1c
Showing 1 changed file with 30 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,34 @@
-# Contributing to rl
+# Contributing to torchrl
 We want to make contributing to this project as easy and transparent as
 possible.
 
+## Installing the library
+Install the library as suggested in the README. For advanced features, 
+it is preferable to install the nightly built of pytorch.
+
+Make sure you install torchrl in develop mode by running
+```
+pip install -e ".[atari,dm_control,gym_continuous,rendering,tests,utils]"
+```
+in your shell.
+
+## Formatting your code
+**Type annotation** 
+
+TorchRL is not strongly-typed, i.e. we do not enforce type hints, neither do we check that the ones that are present are valid. We rely on type hints purely for documentary purposes. Although this might change in the future, there is currently no need for this to be enforced at the moment. 
+
+**Linting**
+
+Before your PR is ready, you'll probably want your code to be checked. This can be done easily by installing 
+```
+pip install pre-commit
+```
+and running 
+```
+pre-commit run --all-files
+```
+from within the torchrl cloned directory.
+
 ## Pull Requests
 We actively welcome your pull requests.
 
@@ -12,6 +39,8 @@ We actively welcome your pull requests.
 5. Make sure your code lints.
 6. If you haven't already, complete the Contributor License Agreement ("CLA").
 
+When submitting a PR, we encourage you to link it to the related issue (if any) and add some tags to it.
+
 ## Contributor License Agreement ("CLA")
 In order to accept your pull request, we need you to submit a CLA. You only need
 to do this once to work on any of Facebook's open source projects.