Home
Rokwire Community is ready to engage with you! This Wiki will guide you through the basic terminology of the Rokwire platform, in addition to the things you will need to be a successful contributor to this community!
Check out the Rokwire Community Navigator for more information about upcoming events, educational resources, publications, and more! Consult our code of conduct to get up to speed on our rules for Community contribution.
Are you already part of the Rokwire initiative? Then read our internal contributor guidelines. Are you new to Rokwire? Read our external contributor guidelines. Everyone should read about our Open Source Community Guiding Principles.
All ready to get working? Then consult our workflow, code reviews, and documentation community standards. Our contributions packager is coming soon, and will allow contributing organizations to submit entire capabilities for review by our internal development team. See how your efforts fit into the scheme of the community at-large by consulting the Rokwire Community contributor master plan.
Check out our video tutorials! Get an in-depth perspective on community resources, how to make the most out of open-source tools, uncovering the potential of Rokwire, and more.
If you would like to participate in Rokwire-related educational opportunities, learn more about our badge (microcredential) system. Our student project include internships with the UIUC iSchool and possible Google Summer of Code sponsorship. Stay tuned for more educational opportunities, including special events, training, Hackathons, and for-credit courses.
You can become a contributor to the Rokwire community through a number of channels. The first step is to join our Slack team or Discord server. Subscribe to our newsletter to stay up to date on our various projects and events. Or check out our educational initiatives to learn more about opportunities you can engage in to learn more about Rokwire.
The most traditional type of contribution is in the form of computer code (building blocks and apps). This includes reporting bugs, requesting features/enhancements, and contributing code. If you are an advanced developer looking to innovate, you should search for existing issues and pull requests in the various Rokwire GitHub repositories to see if what you are planning to contribute is already under discussion.
Other types of contributions are also welcome, from conceptual advances to attending community events, and from participation in community discussions to writing and editing. We look forward to hearing and learning from you (and receiving your contribution)!
We are excited that you may be interested in contributing code to the Rokwire Platform. To maintain standards of programming and to keep things manageable, we request that you follow our open-source workflow procedure. You may also want to read more about Bug Reports, Accessibility Reports, and New Feature Requests.
You will need to sign the Rokwire Contributors License Agreement (CLA) before we can accept your code contributions. Any contributor who is not an employee of the University of Illinois whose official duties include contributing to the Rokwire software, or who is not paid by the Rokwire project, needs to sign the CLA before their contribution can be accepted.
Please complete and sign the CLA and then scan and email a pdf file of the CLA to rokwire@illinois.edu or rokwire-open-source@mx.illinois.edu. If necessary, you can send an original signed agreement to Rokwire, University of Illinois, 331 Grainger Engineering Library, 1301 W. Springfield Avenue, MC-274, Urbana, Illinois 61801.
Rokwire is governed under terms of the Apache license (Version 2.0) and applications are subject to the Terms of Service (ToS)
The Rokwire Code of Conduct governs this project and everyone participating in it. By participating in this project, we expect you to uphold this code. Please report unacceptable behavior to rokwire@illinois.edu or balicea@illinois.edu.
The best way to get started with Rokwire is to clone or fork our Building Blocks API repository on Github. This repository includes a README with instructions on how to get started. We also have a short guide on our Wiki for Working with Building Blocks using the API. For more advanced users, we host an interactive documentation system on Swagger that works with an API Authentication key. Please contact our Community Manager (rokwire-open-source@mx.illinois.edu) for more information.
The API will allow potential contributors to work with the Rokwire building blocks and create application-related things on top of them, such as capabilities and talents. In the future, we will make contributing to Rokwire easier through a Contributions Packager and a Developer's Sandbox.
If you are interested in building contributions (not focused on coding), we offer a number of way to contribute. Lead or manage a discussion at special events. Or attend special event meetings attendance and contribute at your own pace. You can also help create docs and research artifacts, or assist with community-building and maintenance efforts. If you are more the creative type, join design efforts that will enhance the community experience or the Rokwire experience more generally. Start interacting with our community and see what suits you. Not sure how your skills might best serve your open-source participation? Visit our guidance tree to learn what types of contributions best suits your skills and interests.