First off, thank you for considering contributing to cityjson2jsonfg. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
There are many ways to contribute, from testing or documentation, to bug reports, bug fixes and implementing new features.
You can report bugs and request new features by submitting a GitHub Issue. Please select the issue type you need (Bug report or Feature request), answer the questions in the template and submit the issue.
In case you are not sure how to submit a pull request, please refer to GitHub's documentation.
If you are submitting bug fix, a new feature or other contribution in code, please make sure that,
- all tests pass,
- you added new test(s) when appropriate, which cover the bug that you fixed or the changes that you have made.
If you spotted an error, or noticed that something is unclear or missing from the documentation, you could help by fixing it. There is a single file for all documentation, the README.md. Please submit a Pull Request with your changes to this file.
You can test cityjson2jsonfg by converting CityJSON files on your machine. If you encounter any problems, please report the bug.
You need pytest and tox for running the test suite.