Skip to content

Latest commit

 

History

History
105 lines (90 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

105 lines (90 loc) · 3.17 KB
Raw

Contributing

Setup your development environment

You need all requirements.

Branches

  • main : stable releases.
  • dev : beta releases.

To fix a minor problem or add new features create a new branch in this form: username-dev. Please push on the dev branch, any pull request on the main branch will be refused.

Conventions

When you make a pull request make sure to:

  • Test your code with Python 3.8 to be sure not to break compatability.
  • Format your code according PEP 8. PEP8 Check will ensure that your code is correctly formatted .
  • Document your code with reStructuredText if you add new functionality.

If you add a feature that changes the API, notify it explicitly.

Download

Download the dev branch of the project and install dev release:

git clone -b dev https://github.com/Tim-ats-d/Visual-dialog.git
cd Visual-dialog
pip install .

The list of versions and their changelogs can be found here.

Repository Structure

The following snippet describes Visual-dialog's repository structure. This tree does not contain a description of all the files in the repository, only the most relevant ones

.
├── .github/
│   Contains Github specific files such as actions definitions and issue templates.
│
├── doc/
│   Contains the files related to the documentation.
│   │
│   ├── source/
│   │   Contains images used in documentation.
│   │   │
│   │   ├── conf.py
│   │   │   Sphinx's configuration file.
│   │   │
│   │   ├── index.rst
│   │   │   Documentation home page.
│   │   │
│   │   └── visualdialog.rst
│   │       Documentation of all the public classes and methods in Visual-dialog.
│   │
│   ├── make.bat
│   │   To generate documentation on Windows.
│   │
│   └── Makefile
│       To generate documentation on GNU/Linux or MacOS.
│
├── examples/
│   Contains several examples of use cases of Visual-dialog.
│
├── tests/
│   Contains tests for debugging libraries.
│
├── visualdialog/
│   Source for Visual-dialog's library.
│   │
│   ├── __init__.py
│   │
│   ├── box.py
│   │   Contains the parent class BaseTextBox which serves as a basis for the implementation of the other classes.
│   │
│   ├── dialog.py
│   │   Contains DialogBox class, which is the main class provides by the library.
│   │
│   ├── error.py
│   │   Contains exceptions raised by the library.
│   │
│   ├── type.py
│   │   Contains custom type hinting used by the library.
│   │
│   └── utils.py
│       Contains the classes and functions used but not related to the libriarie.
│
├── LICENSE
│
├── CONTRIBUTING.md
│   This document.
│
├── MANIFEST.in
│   Contains list of non Python file.
│
├── README.md
│
└── setup.py
   Installation of the library.