Skip to content

Commit

Permalink
HW6 Part 1 - README + CONTRIBUTION
Browse files Browse the repository at this point in the history
HW6 - Add PyPI badge + Edit Contribution.md
  • Loading branch information
MirrorCraze committed May 11, 2023
2 parents 5b82cf1 + a5ef748 commit 7e850ba
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Python >=3.9

## Contribution
1. Clone the library using ```gh repo clone MirrorCraze/7Wonder-RL-Lib```
1. Fork the library and clone to your local machine
2. Install library and dependencies using
* ```make develop # Download all prerequisites ```
* ```make build # Build the library```
Expand All @@ -14,8 +14,6 @@
1. Run ```make lint``` and ```make test``` and make sure all test passed
2. Submit the PR



## What to focus on now?
* More substantial test (Coverage is still low for now)
* Decoupling Personality.py so that adding new Personality would be easier
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Library providing environment for testing Reinforcement learning in 7 Wonders Ga
[![codecov](https://codecov.io/gh/MirrorCraze/7Wonder-RL-Lib/branch/main/graph/badge.svg?token=7JDHEZ4E76)](https://codecov.io/gh/MirrorCraze/7Wonder-RL-Lib)
[![CodeQL](https://github.com/MirrorCraze/7Wonder-RL-Lib/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/MirrorCraze/7Wonder-RL-Lib/actions/workflows/github-code-scanning/codeql)
[![Build + CodeCov + Pylint/Black](https://github.com/MirrorCraze/7Wonder-RL-Lib/actions/workflows/build.yml/badge.svg)](https://github.com/MirrorCraze/7Wonder-RL-Lib/actions/workflows/build.yml)
[![PyPI](https://img.shields.io/pypi/v/numpy)](https://pypi.org/project/7Wonder-RL-Lib/0.1.0/)

## Overview
There are multiple environments for the AI game testing. However, environments implemented now are mostly covered only the traditional board games (Go, Chess, etc.) or 52-card based card games (Poker, Rummy, etc.) where games do not really have interactions with other players.
Expand Down Expand Up @@ -50,4 +51,4 @@ class RandomAI(Personality):
def make_choice(self, player, age, options):
return random.choice(range(len(options)))
```
```

0 comments on commit 7e850ba

Please sign in to comment.