Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 3.81 KB

Contributing to Teamspeak3 Station Bot

Thank you for considering contributing to our Teamspeak3 Station Bot! We appreciate your time and effort to help make our project better.

The following is a set of guidelines for contributing to this repository. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request. Please note that contributions will be reviewed before being merged.

How to Contribute

There are many ways to contribute to this project! Some suggestions include:

  • Fixing a bug
  • Implementing a new feature
  • Discussing potential improvements
  • Reporting a bug
  • Submitting feedback

Getting Started

Development

To get started, create an issue to discuss the changes you would like to make. This will allow for feedback and suggestions before you spend time coding.

Station Mapping File

No issue is required.

The ATC-station to teamspeak group name mapping can be defined in the atc_station_mappings.json file located in the data directory. Note that the 'id' field is used by the bot to create server roles. This ends up being the name of the role assigned to the controller. The following naming scheme must be adhered to when submitting changes to the ATC-Station-Mapping file - this requirement is valid for VATGER however can be adapted by any other vACC wishing to use this tool.

Ground Stations (DEL/GND/TWR) [(last two letters of ICAO Code)(T/G/C - for Tower/Ground/(Clearance) Delivery)(Station Identifier, e.g. EDDF_S_TWR)]

  • Example for EDDF_S_TWR -> DFTS
  • Example for EDDF_W_GND -> DFGW
  • Example for EDDS_DEL -> DSC

Arrival/Departure Stations (APP/DEP) [(last two letters of ICAO Code)(A/D - for Arrival/Departure)(Station Identifier, e.g. EDDF_N_APP)]

  • Example for EDDF_N_APP -> DFAN
  • Example for EDDF_N_DEP -> DFDN
  • Example for EDDK_APP -> DKA

Center Stations (CTR) [(last two letters of FIR/UIR)(0 or 3 letters that uniquely identify the sector - 0 in the case of 'complete' center stations (e.g. EDMM_CTR, EDGG_CTR, ...))]

  • Example for EDGG_KTG_CTR -> GGKTG
  • Example for EDUU_WUR_CTR -> UUWUR
  • Example for EDGG_CTR -> GG

Pull Request Process

  1. Fork the repository and create a new branch.
  2. Make your changes to the codebase.
  3. Test your changes thoroughly.
  4. Submit a pull request.

We'll try to review your code as soon as possible and let you know if there's anything that requires changing.

License

By contributing to this repository, you agree that your contributions will be licensed under the license that this repository is published under. This can be found on the right side of the GitHub application located under the "about" section.

Thank you for contributing to our Teamspeak3 Station Bot!