Giter Club home page Giter Club logo

aegis-rules's Introduction

aegis-rules

This repo hold the rules that aegis uses to power its list-building capabilities

Version Numbers

aegis uses semantic versioning: major.minor.patch

Major Version Change: Whenever the format of the rules changes such that changes to aegis are required, the major version will bump.

Minor Version Change: When there are official changes to the rules, FAQs, new teams, etc. the minor version will be bumped.

Patch Version Change: Whenever there are minor bug fixes, wording changes, translation fixes, etc. the patch version will bump.

Data Model

TODO: describe the data model

Working Together

TODO: discord or something?

Testing / Deploying

Dev Env Setup

You'll need python to build the rules, on Ubuntu/Debian:

sudo apt update && sudo apt install python3 python3-pip

Install the jsonnet dependency with pip:

pip3 install -r requirements.txt

Optional setup

Editor integrations use the jsonnet binary, on Ubuntu/Debian:

sudo apt update && sudo apt install jsonnnet

or on MacOS (with brew):

brew install jsonnet

Building the Rules

Build the rules by running the python script build.py:

./build.py [--clean] [--release]

  • --clean removes the output dir before doing the build to ensure a clean build
  • --release drops the "-dev" from the version number

Testing Changes

You can load your changes on https://aegis.jakem.co via serve.py.

./serve.py

Will start a server on localhost:4567, which aegis can read and then display the datasheets from.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.