Merge pull request #296 from riscv-non-isa/pr_templates

PR templates

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+<FOR DOC UPDATES FILL ONLY DESCRIPTION AND RELATED ISSUES SECTION AND REMOVE THE OTHERS>
+
+## Description
+
+> Provide a detailed description of the changes performed by the PR.
+
+### Related Issues
+
+> Please list all the issues related to this PR. Use NA if no issues exist
+
+### Ratified/Unratified Extensions
+
+- [ ] Ratified
+- [ ] Unratified
+
+### List Extensions
+
+> List the extensions that your PR affects. In case of unratified extensions, please provide a link to the spec draft that was referred to make this PR.
+
+### Reference Model Used
+
+- [ ] SAIL
+- [ ] Spike
+- [ ] Other - < SPECIFY HERE >
+
+### Mandatory Checklist:
+
+  - [ ] All tests are compliant with the test-format spec present in this repo ?
+  - [ ] Ran the new tests on RISCOF with SAIL/Spike as reference model successfully ?
+  - [ ] Ran the new tests on RISCOF in [coverage mode](https://riscof.readthedocs.io/en/stable/commands.html#coverage)
+  - [ ] Link to Google-Drive folder containing the new coverage reports ([See this](https://github.com/riscv-non-isa/riscv-arch-test/blob/main/CONTRIBUTION.md#uploading-test-stats) for more info): < SPECIFY HERE >
+  - [ ] Link to PR in RISCV-ISAC from which the reports were generated : < SPECIFY HERE > 
+  - [ ] Changelog entry created with a minor patch
+
+### Optional Checklist:
+
+  - [ ] RISCV-V CTG PR link if tests were generated using it : < SPECIFY HERE >
+  - [ ] Were the tests hand-written/modified ?
+  - [ ] Have you run these on any hard DUT model ? Please specify name and provide link if possible in the description
+  - [ ] If you have modified arch\_test.h Please provide a detailed description of the changes in the Description section above.

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## [3.5.2] - 2022-11-25
+  - adding a pull request template
+  - removed riscv-test-stats directory and migrated those to a gdrive folder [here](https://drive.google.com/drive/folders/1KBRy6OgxnOPTDgyfJDj0gcMi5VdMLtVo?usp=share_link)
+  - updated contribution guide on steps to done to upload test stats for PRs
+
 ## [3.5.1] - 2022-10-28
   - Add test cases for P-ext
   - Correct TEST_PKRR_OP() macro in arch_test.h 

CONTRIBUTION.md

@@ -27,7 +27,18 @@ Pull requests are the best way to propose changes to the codebase. We actively w
    ```
    // SPDX-License-Identifier: BSD-3-Clause
    ```
-8. Issue that pull request!
+8. Issue that pull request. We use a PR template and thus your pull request will be pre-populated
+   with a set of necessary and optional checklists which you will need to fill. The template is
+   catered towards PRs adding/modifying tests to this repo. If your PR deals with only doc updates,
+   then the template can be ignored (manually deleting it).
+
+## Uploading Test Stats
+
+If your PR is adding new tests or modifying existing tests, then you are be expected to
+run the coverage on the new tests (via [RISCOF's coverage mode]((https://riscof.readthedocs.io/en/stable/commands.html#coverage)))
+and upload the coverage and data propagation reports to [this Google Drive folder](https://drive.google.com/drive/folders/153nIRznXwzu7N1rWl9CesqwAXLqwHoEx?usp=share_link).
+In this folder create a new folder with the PR number as the name. The stat files must be zipped and
+the naming convention must follow the scheme you [see here](https://drive.google.com/drive/folders/1KBRy6OgxnOPTDgyfJDj0gcMi5VdMLtVo?usp=share_link).
 
 ## Versioning
 

README.md

@@ -6,15 +6,13 @@ This is a repository for the work of the RISC-V Foundation Architecture Test SIG
 - Neel Gala (InCore Semiconductors)
 - Marc Karasek (Inspire Semiconductors)
 
-Details of the RISC-V Foundation, the work of its task groups, and how to become a member can be found at [riscv.org](https://riscv.org/).
+Quick Links:
 
-For more details and documentation on the current test environment see: [doc/README.adoc](doc/README.adoc)
-
-For more details on the test format spec see: [spec/TestFormatSpec.adoc](spec/TestFormatSpec.adoc)
-
-For contributions and reporting issues please refer to [CONTRIBUTION.md](CONTRIBUTION.md)
-
-For more details on the usage of the current framework see : [RISCOF](https://riscof.readthedocs.io/)
+  - Details of the RISC-V Foundation, the work of its task groups, and how to become a member can be found at [riscv.org](https://riscv.org/).
+  - For more details and documentation on the current test environment see: [doc/README.adoc](doc/README.adoc)
+  - For more details on the test format spec see: [spec/TestFormatSpec.adoc](spec/TestFormatSpec.adoc)
+  - For contributions and reporting issues please refer to [CONTRIBUTION.md](CONTRIBUTION.md)
+  - For more details on the usage of the current framework see : [RISCOF](https://riscof.readthedocs.io/)
 
 **Note : The RISCOF framework requires a
 [riscv-config](https://github.com/riscv-software-src/riscv-config) YAML to describe the
@@ -24,7 +22,7 @@ configurations implemented by the DUT**
 
 The older 2.x version of the framework (based on Makefiles) can be found in a separate branch :
 [old-framework-2.x](https://github.com/riscv-non-isa/riscv-arch-test/tree/old-framework-2.x). This
-branch is officiall no longer supported and all changes must occur on the main branch.
+branch is no longer officially supported and all changes must occur on the main branch.
 
 ## Test Disclaimers
 
@@ -42,6 +40,11 @@ when reporting the status of pass/fail on the execution of the architectural sui
    1. The target must have implemented mtvec which is completely writable by the test in machine mode.
    2. The target has initialized mtvec, before entering the test (via RVMODEL_BOOT), to point to a memory location which has both read and write permissions.
 
+## Test Stats
+
+The coverage and data propogation statistics of each test are hosted on
+[Google-Drive](https://drive.google.com/drive/folders/1KBRy6OgxnOPTDgyfJDj0gcMi5VdMLtVo?usp=share_link) for reference. This to avoid bloating this repo in size.
+
 ## Contribution process
 
 Please refer to to [CONTRIBUTION.md](CONTRIBUTION.md) for guidelines on contributions.