Project structure#

The following sections describe the structure of the UltraZohm project and community. Our general community approach is based on the GitHub Open Source Guide. The repository is licensed under the Apache 2.0 license. We strive to be a welcoming, open community and expect everybody to act accordingly. The documentation and code are public. However, the communication channels require new community members to get in touch with the existing community (e.g., mail to info@ultrazohm.com). While this adds a barrier of entry for new community members, this enables community members to share what they are working on freely. This is especially important for currently active research, including pre-publication results and related questions.

  • The project is hosted on Bitbucket (https://www.bitbucket.org/ultrazohm/ultrazohm_sw)

  • We use the UltraZohm Slack channel for direct, informal communication within the community

  • We use Bitbucket issues as a bug tracker (topics related to the UltraZohm itself)

The user groups determine the read/write permissions for Bitbucket. A maintainer has to add users to the groups in Bitbucket (except for Everybody). The UltraZohm community consists of the following user groups:

Maintainer

The core group of people who develop the system, the community and maintain the code as well as the hardware components. Maintainers can write to the develop and main branches by accepting pull requests. Maintainers have admin rights for the Bitbucket team management, i.e., can add and remove users.

Contributor

All users who contribute code or hardware back to the UltraZohm community (i.e., push a commit) are a contributor and everybody is welcome to become a contributor! To become a contributor, please get in contact with a maintainer by using Slack. Contributors have write access to the repository, can create branches, commit to feature branches and create pull requests.

User

Everybody who uses the system is a user, especially everybody who has access to a physical UltraZohm system. Users have read access to the repository and the issue tracker.

Everybody

Everybody has read access to the repository and the pull requests.

Project structure