Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 3.12 KB
Raw

Contributing Guide

The purpose of this guide is to help people get started with making contributions to FASLR. As the project grows these, guidelines should help to establish conventions to keep things organized between contributors.

Since FASLR is still a young project, I would expect these guidelines to rapidly change - for example, there is currently no naming convention for the unit tests, so one will be established in the near future.

Virtual Environment

It is recommended that you establish a virtual environment with the following details below.

Python Version

3.10.2 (main, Jan 15 2022, 18:02:07) [GCC 9.3.0]

Package Dependencies

FASLR depends on some Python packages. These are listed in the file requirements.txt.

You can install these via pip:

pip install -r requirements.txt

IDE

I would recommend using PyCharm since it enforces PEP8 and comes with many other features that aid development, like setting up the virtual environment and marking the namespace package. However, you shouldn't feel bound to use this if you have confidence in another IDE.

Namespace Package

If your IDE has the ability to mark the directory FASLR/faslr as the Namespace Package, please do so.

Commit Guide

Commit messages should be prefixed with a semantic tag followed by a brief summary of the commit's purpose. If necessary, you may add paragraphs to describe what you are doing. Below is a list of prefixes loosely based off of this guide:

  • FEAT: A new feature for the user.
  • FIX: Bug fixes.
  • DOCS: Changes to the documentation.
  • STYLE: Formatting, missing semi colons, etc; no production code change.
  • REFACTOR: Refactoring production code, e.g. renaming a variable.
  • TEST: Making changes to the test suite, no production code change.
  • CHORE: Updating grunt tasks etc.; no production code change.
  • DEPR: Deprecation of existing features.

The semantic tag should be capitalized, followed by a colon. The portion that follows after that should begin with a capital letter and end with a period. For example:

FEAT: Add a label to describe triangle metadata. 
^--^  ^----------------------------------------^
|     |
|     +-> Summary.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

Unit Testing

The unit tests for the project can be found in FASLR/faslr/tests. These are tested using pytest.

A special package called pytest-qt, which is part of the pytest framework, is used to test the GUI components of FASLR. This is used to simulate user actions, such as clicks and button presses.

Pull Requests

When making a pull request, please associate it with an outstanding issue. Make sure to run the unit tests using pytest and that they pass. If you are adding a new feature that currently does not have an existing test, please create one for it.