Contributing

Thank you for expressing interest to contribute to Sprites. Before contributing code, please first open an issue for the bug fix or feature request you would like to contribute and provide a detailed explanation in the GitHub issue. Please name your branches as [username]/[feature/bug/doc]/[hyphonated-name-of-what-you-are-working-on].

Contributing to the codebase requires you to be familiar with Python programming, and developing NVDA add-ons. The NVDA developer documentation also has relevant documentation to help you contribute to the add-on. Once you have everything setup, you should be able to build the add-on by running the command scons source from the repository's source directory. The understanding Sprites internals and understanding data logging pages contain information of the internals of Sprites.