Contributing

Q&A

For support, please start a discussion in the “Q&A” category.

Ideas

To share an idea for a new feature or an improvement, please start a discussion in the “Ideas” category.

Bug reports

For bug reports, please open an issue based on the “Bug report” template. Make sure you provide a complete description of how to reproduce the problem or a runnable example where it can be observed. If the problem occurs for specific chart data, share the data. Examples should be minimal, meaning no redundant code should be included. References to project-specific code (such as a resource or a ViewModel not included in the example) should be removed or replaced. The information provided should enable us to reproduce the issue.

Before reporting a bug, please ensure that it affects one of these Vico versions:

• the latest stable version
• the latest pre-release version of the upcoming patch or minor update (if applicable)
• the latest pre-release version of the upcoming major update (if applicable)

Pull requests

For pull requests, please follow these guidelines:

• Use master as the base branch.
• Use Ktlint to format your code. Follow the conventions described on the “Coding conventions” page of the Kotlin documentation. If there’s a conflict between these two, Ktlint takes precedence.
• Add documentation for all public APIs.