Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Commit

Permalink
Update and rename CONTRIBUTING.rst to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
advaithm582 authored Sep 1, 2021
1 parent 8f7634a commit fd2a8bb
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions CONTRIBUTING.rst → CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
===============================
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,
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

0 comments on commit fd2a8bb

Please sign in to comment.