Closed alexorr closed 4 years ago
@alexorr i can't tell what changes you made to @cecilia27 original PR other than adding the readme.txt and moving it to another folder location. i have pushed my changes to her fork. you can see the commit history there. closing this PR in favor of the original one.
Proposed Changes
Cecilia submitted this project of substitution examples. These types of things have been in the tools or utilities folders, but I'm proposing we create a folder just for examples along with a new category on the developer page.
Types of Changes
What types of changes does your code introduce? Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask @cwhitty. We're here to help! This is simply a reminder of what we are going to look for before merging your code.[x] Project contains a file called documentation/readme.txt with metadata necessary for the catalog. The readme.txt file must contain these 4 lines at the top of the file:
Project: Name of project
Description: 80 or so characters describing the contents of the project
Category: ("library" | "automation" | "framework")
Class: ("Community" | "Tested by Spirent" | "Reference").
Other info like user instructions, a description of the intended use case, etc. can be added to the readme.txt after the 4 required lines.
Note: A README.md file will be automatically generated including everything in the readme.txt file and a list of files, QuickCalls, and procedures with info from iTest's documentation fields. Do not create a README.md file, it will be overwritten. For the best possible documentation, fill out the description fields in each test case, procedure and QuickCall.