Skip to content
This repository has been archived by the owner on Dec 10, 2017. It is now read-only.

Latest commit

 

History

History
19 lines (12 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

19 lines (12 loc) · 2.19 KB

Contributing to kancolle-auto

General guidelines

Be courteous to yours truly (@mrmin123) and other users of kancolle-auto! This is a hobby project for a video game, so relax, have fun, and thanks for contributing! Hopefully you're getting to learn a thing or two about scripting and/or automation, as well!

Bug reporting / feature requests

If you've found a bug in kancolle-auto, or if you'd like to request a feature, please create a ticket on the kancolle-auto issue tracker. If you can, please search previous tickets in case your bug report or feature request was made already. Please read and follow the directions outlined in the issue template.

Due to the nature of the project and my lack of time to support everything, tangentially-related issues (including Sikuli-specific issues) may be closed without much warning.

Code contribution

kancolle-auto was built up piecemeal and a lot of interconnected and complex logic exists all over the place. I've tried to comment the code where possible, but it wasn't possible to account for every single scenario using in-line comments. Code contribution PRs are more than welcome, but please understand that I will give it a good amount of scrutiny before I merge it in case of potentially unaccounted corner/edge-cases and resulting downstream failures.

When making a PR, please create or reference a ticket in the kancolle-auto issue tracker. Please use the following naming convention for your branch: [ticket #]_[relevant branch title] (example: 303_ssv_support, referencing ticket #303).

Asset contribution

Please reference the Asset generation guide for creating assets.

When making a PR, please create or reference a ticket in the kancolle-auto issue tracker. Please use the following naming convention for your branch: [ticket #]_[relevant branch title] (example: 303_ssv_support, referencing ticket #303).