Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (52 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

65 lines (52 loc) · 2.49 KB

Contributing to SLOTHY

Welcome! We are pleased to see you are interested in contributing to SLOTHY.

In the following, we will lay out a few foundational things that are important for your contributions.

Setup

The setup for the development works just as the one we present in the README.

Project Structure

This repository consists of the following, important elements:

  • docs: Code related to building our sphinx documentation.
  • examples: Collection of assembly files used as examples for SLOTHY. The directory is split up in a part containing the naive implementations serving as a starting point, and another part containing the SLOTHY-optimized routines.
  • paper: Material relevant to the publication of the paper Fast and Clean: Auditable high-performance assembly via constraint solving.
  • slothy: Core-part of SLOTHY. Contains the architectural/microarchitectural models, as well as the actual implementation of SLOTHY.
  • tutorial: A tutorial introducing various aspects about the usage of SLOTHY as a tool.
  • example.py: Script containing the invocations of SLOTHY, to optimize the naive assembly implementations from examples into their optimized counterparts.

Quality Assurance

Providing Examples

In case you add new features to SLOTHY, extend the architectural/microarchitectural model, or make any other modification to the tool that may change its operation, we highly appreciate if you add an example to the example.py script, that will cover your modifications.

The example.py script gets run with the --dry-run flag in our CI in order to catch superficial errors and some common pitfalls.

Style

To ensure a certain level of quality for the code in this repository, we ask contributors to verify whether the code satisfies a set of formatting and style requirements. For this, we employ flake8 and black.

You can check the formatting of the source code, including the sphinx doc strings by running flake8 . in the root of the repository.

In order to automate the formatting process, you can first check how black would adjust the code by running black --check --diff .. If you are happy with the proposed changes, run black . to apply them to the code.

Note that these tools will also be run by our CI, which needs to pass before we can merge your pull requests.