Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.46 KB
Raw

Contributing

Prior to contributing to this repository, please reach out to the owner of this repository to discuss the changes you wish to make either through creating an issue, emailing the owner, or any other preferred method of communication.

Built With

image

Using the legacy release of Python 3.9.0

Installation

rwar uses requirements.txt to keep track of modules used. To install the modules listed in this file, run the following command:

pip3 install -r requirements.txt

Note: If your changes require additional modules, please add them to the requirements.txt file before raising PR. This can be done with the command pip3 freeze > requirements.txt

Formatting

As the source code formatter, rwar uses black. Ensure you run the following command after your changes have been implemented.

black ./rwar.py ./src/

Linting

rwar follows the PEP8 style guide and uses pylint to enforce this. To lint your code, run the following command:

pylint ./rwar.py ./src/

Testing

rwar uses the unittest framework for testing. To test the code, run the following command:

python3 -m unittest discover