Small updates to contributors guide (#4825) (#5043)

* docs/contributing: refer to latest version of contrib guide * docs/contributing: grammer fix * docs/contributing: fix command for test coverage report * added CHANGES file (cherry picked from commit f079e36) Co-authored-by: Guus Bertens <[email protected]>
aio-libs · Oct 15, 2020 · eb581ae · eb581ae
1 parent 36f402a
commit eb581ae
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES/4810.doc b/CHANGES/4810.doc
@@ -0,0 +1 @@
+Update contributing guide so new contributors read the most recent version of that guide. Update command used to create test coverage reporting.
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -12,6 +12,9 @@ I hope everybody knows how to work with git and github nowadays :)
 
 Workflow is pretty straightforward:
 
+  0. Make sure you are reading the latest version of this document.
+     It can be found in the GitHub_ repo in the ``docs`` subdirectory.
+
   1. Clone the GitHub_ repo using the ``--recurse-submodules`` argument
 
   2. Setup your machine with the required dev environment
@@ -20,7 +23,7 @@ Workflow is pretty straightforward:
 
   4. Make sure all tests passed
 
-  5. Add a file into ``CHANGES`` folder (see `Changelog update`_ for how).
+  5. Add a file into the ``CHANGES`` folder (see `Changelog update`_ for how).
 
   6. Commit changes to your own aiohttp clone
 
@@ -131,7 +134,7 @@ Use:
 
 .. code-block:: shell
 
-   $ make cov
+   $ make cov-dev
 
 to run test suite and collect coverage information. Once the command
 has finished check your coverage at the file that appears in the last
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Update contributing guide so new contributors read the most recent version of that guide. Update command used to create test coverage reporting.