Contributing

Discord

Feel free to drop join the Discord channel to get in touch with Telemachus' contributors. Oftentimes, it's easier to hop in the channel and ask questions, and we're more than happy to lend a hand. If Discord isn't your thing, feel free to open an issue - we welcome those, also!

Issues and Ideas

Issues are very valuable to this project. Please open a new issue if you want to:

• report a bug or defect with the plugin
• ask a question to the community or need help
• want to make a suggestion for improvement
• have a feature request

Thank you for creating a new issue! These are just as important to us as the pull requests because they provide a critical connection between the developers and the community.

Pull Requests

Pull requests are a great way to get your ideas into this repository. When deciding if we merge in a pull request, we look at the following things:

Does it state intent

You should be clear which problem you're trying to solve with your contribution.

For example:

Add link to code of conduct in README.md

Doesn't tell us anything about why you're doing that

Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md

Tells us the problem that you have found and the pull request shows us the action you have taken to solve it.

Is PR of good quality

• There are no spelling mistakes
• It reads well
• For english language contributions: Has a 'Good' score on Hemingway

Does the contribution move Telemachus closer to our vision

Telemachus aims to provide:

• a fast, web-based API plugin for Kerbal Space Program
• the ability to integrate with other mods using a standardized data path
• a developer experience based around clean code principles and clean architectures

Does the PR follow the contributor covenant

This repository has a code of conduct, This repository has a code of conduct, we will remove things that do not respect it.

Attribution

This contribution guide was adapted from PurpleBooth's template