From fd2a8bbbd7be880a345e3fc12be9810e30b17812 Mon Sep 17 00:00:00 2001 From: Advaith Menon <83835839+advaithm582@users.noreply.github.com> Date: Wed, 1 Sep 2021 23:20:18 +0530 Subject: [PATCH] Update and rename CONTRIBUTING.rst to CONTRIBUTING.md --- CONTRIBUTING.rst => CONTRIBUTING.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) rename CONTRIBUTING.rst => CONTRIBUTING.md (69%) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.md similarity index 69% rename from CONTRIBUTING.rst rename to CONTRIBUTING.md index e5255fb..a1c546d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.md @@ -1,9 +1,8 @@ -=============================== Contributing to Zoom Autojoiner =============================== Introduction -============ +------------ Zoom Autojoiner (ZAJ) is a huge project, more than 900 lines of code. It is at an early stage and is growing pretty fast. However, when the project becomes big, @@ -11,14 +10,12 @@ new people should be able to understand the code. Keeping this in mind, it is imperative on your part to follow the below guidelines. Guidelines -========== +---------- + All code must adhere to **PEP 8**. + When writing docstrings, follow **Google Style.** + Please be succinct when writing the docstring + Add PEP 484 type hints. -+ Try to use the new Extensions API to the maximum extent. ++ ~~Try to use the new Extensions API to the maximum extent.~~ broken in PyInstaller compiled version + Do write code that + fixes issues - + implements features that fall into the `goals`_ of this project - -.. _`goals`: https://github.com/advaithm582/zoom-autojoiner-gui#goals + + implements features that fall into the [goals](https://github.com/advaithm582/zoom-autojoiner-gui#goals) of this project