https://github.com/ciscodevnet/code-exchange-repo-template
Template for creating a repo for software related to Cisco technologies to be shared with the DevNet community via Code Exchange
https://github.com/ciscodevnet/code-exchange-repo-template
Last synced: 11 months ago
JSON representation
Template for creating a repo for software related to Cisco technologies to be shared with the DevNet community via Code Exchange
- Host: GitHub
- URL: https://github.com/ciscodevnet/code-exchange-repo-template
- Owner: CiscoDevNet
- License: bsd-3-clause
- Created: 2019-01-10T20:44:33.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T17:47:24.000Z (about 2 years ago)
- Last Synced: 2025-01-16T23:42:56.246Z (about 1 year ago)
- Homepage: https://developer.cisco.com/codeexchange/
- Size: 1.83 MB
- Stars: 37
- Watchers: 5
- Forks: 61
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Code Exchange Repo Template
This repository is a template to be used when creating a new repository containing sample code, a sample application, or some other software related to Cisco technologies and to be made available for use by the Cisco DevNet community through [Code Exchange](https://developer.cisco.com/codeexchange/).
## Instructions
You have two options, if you have familiarity with Python, use the cookiecutter steps. Otherwise you can manually create a copy of this repo template.
### Cookiecutter Automated Repo Creation
This process uses [cookiecutter](https://github.com/audreyr/cookiecutter) to auto-generate the files for you. This is helpful if you create multiple use cases.
> Note: This template assumes the BSD 3-Clause License, you can change it be other licenses afterwards if that is not what you want.
1. Issue this command `pip install cookiecutter` to get ready to use the template.
2. Use this command and answer the questions: `cookiecutter https://github.com/CiscoDevNet/code-exchange-repo-template`
3. Update the [README](./README.md), replacing the contents below as described in text within each section of the README. Feel free to combine or omit sections where appropriate.
4. Update the [LICENSE](./LICENSE), replacing the file with the license selected for your code. See the [*Licensing info*](https://github.com/CiscoDevNet/code-exchange-repo-template/tree/main/manual-sample-repo#licensing-info) section of this README for more info.
5. Delete these instructions and everything up to the _Project Title_ from the README.
6. Write some great software and [submit](https://developer.cisco.com/codeexchange/github/submit) it to Code Exchange and/or Automation Exchange.
#### Example
```bash
use-cases$ cookiecutter https://github.com/CiscoDevNet/code-exchange-repo-template
project_name [my-awesome-devnet-code-exchange-project]: my-first-project
project_description [baseline DevNet Code Exchange Project]: New Things to come!
author_name [Your Name Here]: User Name
author_email [youremail@domain.com]: user@cisco.com
use-cases$ tree
devnet-code-exchange/ my-first-project/
cookiecutter-devnet-code-exchange/
use-cases$ tree my-first-project/
my-first-project/
├── LICENSE
├── NOTICE
└── README.md
0 directories, 3 files
use-cases$
```
### Manual Repo Creation
If you are only creating one use case, this process is probably easier.
1. Create a new repository.
2. Copy all the files inside `manual-sample-repo` into your new repository.
3. Update the [README](./README.md), replacing the contents below as described in text within each section of the README. Feel free to combine or omit sections where appropriate.
4. Update the [LICENSE](./LICENSE), replacing the file with the license selected for your code. See the [*Licensing info*](https://github.com/CiscoDevNet/code-exchange-repo-template/tree/main/manual-sample-repo#licensing-info) section of this README for more info.
5. Delete these instructions and everything up to the _Project Title_ from the README.
6. Write some great software and [submit](https://developer.cisco.com/codeexchange/github/submit) it to Code Exchange and/or Automation Exchange.