Skip to content

Commit 9605eee

Browse files
authoredFeb 20, 2018
Merge pull request #9 from CiscoDevNet/add-contrib
Adds contributing guidelines
2 parents ec62d73 + 4a27d18 commit 9605eee

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed
 

‎contributing.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# How to contribute to a Learning Lab
2+
3+
For Learning Labs, there are a few primary ways to help:
4+
- Testing the Learning Lab and then reporting issues in the repo or in the common issues tracking repo
5+
- Using the Issue tracker to report issues or comment that you will work on an issue
6+
- Updating the content in the Learning Lab repo
7+
- Requesting or creating a release
8+
- Contacting DevNet to publish new or updated Learning Labs
9+
10+
## Using the issue tracker
11+
12+
For Learning Labs, there are two potential places to track issues, depending on
13+
whether the repo is a public or private repo.
14+
15+
For public repo Learning Labs, use the issue tracker in the repo. All Learning Labs repos in the CiscoDevNet organization have a topic of `learning-labs`.
16+
17+
For private Learning Labs, use the common Issue tracker in the [CiscoDevNet/learning-labs-issues](https://github.com/CiscoDevNet/learning-labs-issues) repo.
18+
19+
For DevNet Express events, use these three Issue tracker repos based on the content track:
20+
* https://github.com/CiscoDevNet/devnet-express-dna-issues
21+
* https://github.com/CiscoDevNet/devnet-express-cc-issues
22+
* https://github.com/CiscoDevNet/devnet-express-dci-issues
23+
24+
Use the issue tracker to suggest additions, report bugs, and ask questions.
25+
This is also a great way to connect with the developers of the project as well
26+
as others who are interested in this solution.
27+
28+
Also use the issue tracker to find ways to contribute. Test a lab, find a bug,
29+
log an issue, or offer an update, comment on the issue that you will take on
30+
that effort, then follow the _Changing the Learning Lab content_ guidance below.
31+
32+
## Changing the Learning Lab content
33+
34+
Generally speaking, you should fork the Learning Lab repository, make changes in
35+
your fork, and then submit a pull request (PR). All new content should be tested
36+
to validate that documented tasks work correctly. Additionally, the content
37+
should follow the [Learning Lab Style Guide](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki/Lab-Style-Guide).
38+
39+
The [DevNet Writing Guidelines Wiki](https://github.com/CiscoDevNet/devnet-writing-guidelines/wiki)
40+
describes the review and publishing process in detail. Please feel free to request reviews from DevNet contributors you see in the repository and we will review submissions.

0 commit comments

Comments
 (0)
Failed to load comments.