Contributions are welcome and encouraged! Pull requests may be submitted by anyone. In order to keep the code maintainable, the following guidelines are in place.
- Indentations use tabs, variables use
snake_case, classes useCamelCase. - When possible, functionality should be packaged in classes or methods in a unit-testable manner.
- Line endings are CRLF.
- Implementations of classes should have methods in the same order.
- Use f-strings and single quoted strings where possible.
- Python 3.8
- pip3
- Please discuss any new features or changes you'd like to make with the repository owner(s) before submitting your pull request: we're excited to hear about your ideas!
- All new functionality needs unit tests to exercise its behavior, where pragmatic. This helps minimize regression issues and shows how code runs.
If you are interested in becoming a regular contributor to ham-radio-sync, please reach out and ask! The best channel of contact is through github.
This project is offered as an open-source project, and will be offered that way indefinitely. We ask that any projects that are inspired by or associated with projects here cite appropriately, including a link to this repository.