Cisco RADKit Developer is a public community space for sharing, exploring, and collaborating on RADKit projects. All repositories are open for reading, cloning, and forking, contributions are welcome via Pull Requests.
- License
- Contributing a Project
- Project Requirements
- Repository Setup Checklist
- Community Expectations
- Recommendations
All material is released under the Apache 2.0 License, which ensures open collaboration, freedom to use the software, and protection for contributors.
Important:
- Contributors must understand and agree to the license terms.
- If work is done on behalf of an employer, the employer may hold copyright.
- All contributions must include a Developer Certificate of Origin (DCO) sign-off.
- Create a GitHub account if you don't already have one.
- Prepare your project locally or in your own GitHub repository.
- Verify your project meets the Project Requirements.
- Email radkit-librarians@cisco.com with:
- Your repository link
- A brief project description
- Maintainer contact information
- The RADKit librarians will review your submission.
- If accepted, your project will be added to the Cisco RADKit Developer GitHub organization.
After onboarding, you retain maintainer privileges, can grant collaborators access, and community members can submit Pull Requests and Issues.
If you can no longer maintain your project:
- Add a note to your README indicating the maintenance status.
- Email radkit-librarians@cisco.com.
The librarians may help find a new maintainer or archive the repository if it becomes inactive.
Submitted projects must:
- Be relevant to RADKit users or developers
- Include clear and concise documentation
- Build and run as described
- Follow licensing rules
- Be and remain publicly accessible
- Accept community collaboration
Projects that do not meet these requirements may be declined or archived.
Every commit must be signed off using git commit -s, certifying that you have the right to submit the code.
First, make sure your git identity is configured:
git config user.name "John Smith"
git config user.email "johnsmith@example.com"Then sign off your commits:
git commit -s -m "My commit message"
# Adds: Signed-off-by: John Smith <johnsmith@example.com>By signing off, you confirm you have the right to submit the code and that it will be publicly accessible. See the Developer Certificate of Origin for full terms.
Use this checklist when preparing your repository:
| Item | Requirement |
|---|---|
| Name | Catchy or descriptive, avoid generic names like generic-tool. For tools/libraries, creative names are encouraged (e.g., IxT). For demos, use descriptive names (e.g., jwt-login-demo). |
| Description | Clearly explain what the project does, its type (tool, example, library), and who it helps. |
| README.md | Must include: what the project does, dependencies, build/run instructions, and attribution for any derived code. |
| LICENSE | Add a LICENSE file, Apache 2.0 is recommended. |
- Code is provided "as is", use it at your own risk.
- Bug fixes and extensions are welcome back as Pull Requests.
- Your code will be available to everyone in source form.
- It may be used for teaching, building products, or as a starting point for other projects.
- Only contribute code you own the intellectual property rights (IPR) to.
- Avoid any references to customers: names, network configs, templates, etc.
- Supporting your code is encouraged but not mandatory, reviewing PRs and responding to issues is appreciated.
- Add test cases and include instructions on how to run them.
- Specify which RADKit API/SDK version your project is tested against, not all features are backwards compatible.
- Tag releases in Git and maintain a
CHANGESfile or Release Notes if you publish versioned releases.
Thank you for your interest. Happy collaboration!