From a2430bbe7308c624b77cac675c5a9bdaac0dc0a7 Mon Sep 17 00:00:00 2001 From: chuehlien Date: Tue, 15 Dec 2020 15:38:39 -0500 Subject: [PATCH 1/3] Make minor updates to README to ensure compliance with CodeHub template. --- README.md | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f86b143c..019b1b2c 100644 --- a/README.md +++ b/README.md @@ -45,34 +45,45 @@ Instructions for building MMITSS are in the /docs/mmitss-deployment/mmitss-build Tests are provided for many of the MMITSS components, but they are not currently automated. Where specific tests are provided, an input generator and output receiver (if used) is provided. For example see /src/mrp/traffic-controller-interface/tests or /src/mrp/priority-request-solver/test. Additional test scripts and automated testing are planned in future sprints. -# Deploying and Executing MMITSS +## Deploying and Executing + +### MMITSS Instructions for deploying MMITSS are in /docs/mmitss-deployment/mmitss-field-deployment.docx -# MMITSS Simulation Platform +### MMITSS Simulation Platform Instructions for setting up MMITSS Simulation using VISSIM are in /docs/mmitss-deloyment/mmitss-simulation-deployment.docx # Additional Notes +__Known Issues:__ See [Issue Tracker](https://github.com/mmitss/mmitss-az/issues). +# Version History and Retention +__Status__: This project is in the release phase. -## Open source license +__Release Frequency__: This project is updated approximately once every 2-3 weeks -By contributing to the Multi-Modal Intelligent Traffic Signal Systems (MMITSS) open source project, you agree that your contributions will be licensed under its Apache License 2.0 license. +__Release History__: See [Releases](https://github.com/mmitss/mmitss-az/releases) + +__Retention__: This project will remain publicly accessible for a minimum of five years (until at least 06/15/2025). + + +# License +By contributing to the Multi-Modal Intelligent Traffic Signal Systems (MMITSS) open source project, you agree that your contributions will be licensed under its Apache License 2.0 license. -## Tools +# Contributions -### Issue tracker +## Issue tracker Contributors will use Github's issue tracking system to record and manage issues that are reported by users of MMITSS AZ in the field. These may include performance requests, defects, and new feature requests. The follow operating procedure highlights how the MMITSS AZ development team will address and respond to reported issues. -Issue Repository: (https://github.com/mmitss/mmitss) +Issue Repository: (https://github.com/mmitss/mmitss-az/issues) -### Pull requests +## Pull requests -[MMITSS AZ GitHub Pull Request Page](https://github.com/mmitss/mmitss/pulls) +[MMITSS AZ GitHub Pull Request Page](https://github.com/mmitss/mmitss-az/pulls) All pull requests will be reviewed by the MMITSS AZ team. During the review of your pull request the team member will either merge it, request changes to it, or close it with an explanation. For major changes the reviewer may require additional support from the team, which could cause some delay. We'll do our best to provide updates and feedback throughout the process. Feel free to open pull requests, and the MMITSS team will communicate through it with any comments. **Before submitting a pull request**, please make sure the following is done: @@ -86,6 +97,7 @@ All pull requests will be reviewed by the MMITSS AZ team. During the review of y - Please contact the MMITSS with qny questions 5. Format your code as outlined in the style guide + ## Contributor Covenant Code of Conduct #### Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. @@ -119,5 +131,14 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. +# Contact Information + +Contact Name: Larry Head + +Contact Information: klhead@arizona.edu, (520) 621-2264 + +# Acknowledgements +To track how this government-funded code is used, we request that if you decide to build additional software using this code please acknowledge its Digital Object Identifier in your software’s README/documentation. +Digital Object Identifier: https://doi/org/10.21949/1520606 From d6197bbb4d2ef4433772b41bf71f5a8414c38a37 Mon Sep 17 00:00:00 2001 From: chuehlien Date: Wed, 16 Dec 2020 14:15:16 -0500 Subject: [PATCH 2/3] Fix typo in doi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 019b1b2c..e888cefd 100644 --- a/README.md +++ b/README.md @@ -141,4 +141,4 @@ Contact Information: klhead@arizona.edu, (520) 621-2264 To track how this government-funded code is used, we request that if you decide to build additional software using this code please acknowledge its Digital Object Identifier in your software’s README/documentation. -Digital Object Identifier: https://doi/org/10.21949/1520606 +Digital Object Identifier: https://doi.org/10.21949/1520606 From 49ffd293ba607e0fcfa6fd6055ff863ce0669121 Mon Sep 17 00:00:00 2001 From: chuehlien Date: Wed, 16 Dec 2020 14:19:44 -0500 Subject: [PATCH 3/3] Minor changes in link formats --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e888cefd..cc6cac33 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,10 @@ By contributing to the Multi-Modal Intelligent Traffic Signal Systems (MMITSS) o # Contributions ## Issue tracker -Contributors will use Github's issue tracking system to record and manage issues that are reported by users of MMITSS AZ in the field. These may include performance requests, defects, and new feature requests. The follow operating procedure highlights how the MMITSS AZ development team will address and respond to reported issues. -Issue Repository: (https://github.com/mmitss/mmitss-az/issues) +[MMITSS AZ GitHub Issue Tracker Page](https://github.com/mmitss/mmitss-az/issues) + +Contributors will use Github's issue tracking system to record and manage issues that are reported by users of MMITSS AZ in the field. These may include performance requests, defects, and new feature requests. The follow operating procedure highlights how the MMITSS AZ development team will address and respond to reported issues. ## Pull requests