Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
4 changed files
with
87 additions
and
870 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# **Contributing to Wi-Fi Test Suite** | ||
|
||
**Thank you for your interest in contributing to the Wi-Fi Alliance's (WFA) Wi-Fi Test Suite project!** | ||
|
||
## 1. Become a Contributer | ||
|
||
Contributors are members who contribute to the code, testing, bug reporting, documentation, design, discussion etc. Contributors get involved in the project through the issue tracker, forum, and the contributor mailing list. Changes are submitted through pull requests which will be considered for inclusion in the project by Committers. | ||
|
||
How to become one: | ||
Contributors must sign the WFA Contributor Agreement before contributing work to WFA Wi-Fi Test Suite software thru the following URL: | ||
http://www.wi-fi.org/wi-fi-alliance-contributor-agreement | ||
|
||
Contributors must follow the Contribution Standards, which is in sections 2 through 6 of this file. Submit a pull request. We'll evaluate the request to determine if it aligns with the projects goals. In addition to the goal alignment there is also a requirement to include appropriate tests and these tests run without failure. If all of the requirements are met we’ll accept it and merge it into the project. | ||
|
||
## 2. Propose a Submission | ||
|
||
Proposals can be submitted via a WFA Wi-Fi Test Suite Blog or as an idea to the Contributor Mailing List. Submissions that follow our contribution standards and are aligned with the direction of the project will be accepted. Please review Wi-Fi Test Suite contributor model for more information about how proposals get processed once submitted. | ||
|
||
## 3. Minimum Requirements | ||
|
||
The goal of these requirements is to ensure quality, API consistency, code reusability, and maintainability of the contribution. All contributions must satisfy: | ||
|
||
- Complete API Docs and inline code comments | ||
- Unit tests with 90% line coverage | ||
- User Guide (Components only) | ||
- Proper commit logs | ||
- Proper purpose of the functionality | ||
|
||
## 4. Further Recommendations | ||
|
||
We recommend the following process for contributing great code to Wi-Fi Test Suite: | ||
|
||
4.1 Diff Before Every Commit | ||
|
||
Get into the habit of running git diff or git diff --cached before every commit. | ||
|
||
4.2. Commits Should Be Granular | ||
|
||
You should keep each commit as granular as possible. For instance, do not check in 2 bug fixes in one commit -- separate them out into 2 commits. Any big change must be split into multiple commit as small feature | ||
|
||
4.3. Coding Style | ||
|
||
Please make sure your changes conform to Style Guide for Python Code (PEP8). | ||
Or download pylint and run on python scripts: http://www.pylint.org/#install. | ||
|
||
4.4. Get feedback early and often | ||
|
||
- A draft about the proposal. | ||
- An API review validates your initial approach. | ||
- A design review validates your high-level architecture. | ||
- A code review validates your implementation details. | ||
|
||
4.5. Documentation is just as important as code | ||
|
||
- API docs | ||
- Examples | ||
- User guides | ||
|
||
4.6. Do your tests | ||
|
||
- Unit | ||
- Functional | ||
- Performance | ||
|
||
## 5. License Updates | ||
|
||
Any submission that uses open source code from another project must be explicitly called out and is subject to review. Any proprietary code from any project, should not be submitted, and will be rejected. | ||
|
||
## 6. Right to Revert | ||
|
||
Once the contribution has been merged into the repo, if any issues arise in the integration environment or upon subsequent feedback, the contribution may be reverted. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,30 @@ | ||
Wi-Fi Test Suite - UCC (Unified Command Console) | ||
Latest Release: v9.0.0 | ||
# **Wi-Fi Test Suite - UCC (Unified Command Console)** | ||
**Latest Release: v9.0.0** | ||
|
||
-- Introduction -- | ||
## Introduction | ||
Wi-Fi Test Suite is a software platform originally developed by Wi-Fi Alliance to support certification program development and device certification. Non-proprietary components are provided under the ISC License and can be accessed at the [Wi-Fi Test Suite] open source project on GitHub. Wi-Fi Alliance members can access the full software package, including proprietary components, on the Wi-Fi Alliance [member site]. | ||
|
||
UCC runs tests defined by input text files containing CAPI commands. The individual CAPI | ||
commands within the input files are handled by UCC to perform functions such as DUT | ||
configuration, traffic stream definition, and test execution. UCC will direct specific CAPI | ||
commands to the appropriate device. This is accomplished via the Control Network. | ||
## UCC and how to get it | ||
Unified CAPI Console provides the overall control console for Wi-Fi Test Suite. | ||
|
||
-- Get WTS UCC -- | ||
UCC runs tests defined by input text files containing CAPI commands. The individual CAPI commands within the input files are handled by UCC to perform functions such as DUT configuration, traffic stream definition, and test execution. UCC will direct specific CAPI commands to the appropriate device. This is accomplished via the Control Network. | ||
|
||
The source code is currently hosted on GitHub at: http://github.com/wifialliance/Wi-FiTestSuite | ||
|
||
-- Dependencies -- | ||
UCC can be downloaded through the open source repository http://github.com/wifialliance/Wi-FiTestSuite or by members in the most recent Wi-Fi Test Suite package | ||
|
||
## Dependencies | ||
Make sure you have python version 2.7 installed: | ||
https://www.python.org/download/releases/2.7/ | ||
|
||
-- Installation from sources -- | ||
|
||
Refer to our Install Guide for instructions on setting up UCC from scratch | ||
|
||
-- License -- | ||
## Installation from sources | ||
Refer to our Build Guide for instructions on compiling UCC from scratch | ||
|
||
Please refer to LICENSE.md. | ||
|
||
-- Documentation -- | ||
## License | ||
Please refer to LICENSE.txt | ||
|
||
## Documentation | ||
docs/Build_Guide.pdf | ||
|
||
-- Issues and Contribution Guidelines -- | ||
|
||
## Issues and Contribution Guidelines | ||
Please submit issues/ideas to support@wi-fi.org. | ||
|
||
Both Wi-Fi Alliance members and non-members can contribute to the Wi-Fi Test Suite open source project. Please review the contribution agreement prior to submitting a pull request. | ||
Please read more on contributions in CONTRIBUTING.md. |
Oops, something went wrong.