Skip to content

Commit

Permalink
Add contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenpieters committed May 17, 2023
1 parent 851540f commit 6efcf69
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contribution Guide

This guide will help you get set up on contributing to the netrunner comprehensive rules project.

## Overview

Overview of the folder structure in the project:

```
- .github | files for github actions
- data | input data for the document generation
- rules_doc_generator | python project for the format conversion
```

## Setup

To get set up with the Python project you'll need at least Python 3.11 and install the required dependencies.

```
pip install -r requirements.txt
```

After that you can generate the output documents via the python module.

```
python -m rules_doc_generator
```

This will generate an output folder corresponding to each of the output formats (currently: `html` and `latex`). When making changes and pushing them to the repository, you should verify that the output can be generated and looks like you expect.

0 comments on commit 6efcf69

Please sign in to comment.