Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 914 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 914 Bytes

Contributing to the Rogue-Like Package Example

Suggest Improvements

Open up issues:

https://github.com/pythonarcade/roguelike/issues

Fix Bugs or Implement Features

Before you code, please open an issue for what you are coding, and then check in code with that issue number (like "issue #146") as part of the comments.

Improve the Documentation

You can also suggest improvements to the documentation. All the documentation is in the codebase.

Improve Test Cases

Improving code coverage, and making better test case examples is appreciated.

How to Build

In the root directory of the project, you should be able to type:

  • make full (for Windows)
  • sudo ./make.sh (for Linux)

This will build the project, install it, and run all of the tests.