diff --git a/_pages/docs/adding_to_pyhc_project_list.md b/_pages/docs/adding_to_pyhc_project_list.md index 56397c7..1bce784 100644 --- a/_pages/docs/adding_to_pyhc_project_list.md +++ b/_pages/docs/adding_to_pyhc_project_list.md @@ -80,8 +80,11 @@ on your forked repository's GitHub page. This will create a request to merge tho website repository. In this PR, write a short blurb about your project, including the name, a general description of the project, and what grades were assigned for the PyHC standards. If any of the standards fall below the "Good" classification, make sure to provide some remarks about why that is, and what the project's plan is for improvement. As stated in the -reviewing guidelines, at present, no projects will be rejected from the PyHC Project list. However, at the -PyHC Spring 2020 meeting we will set a date by which projects will be kicked off if they have any "Requires improvement" grades. +reviewing guidelines, at present, no projects will be rejected from the PyHC Project list. However, we will +eventually set a date by which projects will be kicked off if they have any "Requires improvement" grades. Feel free to also post about your project and the PR in the [Element chat group](https://app.element.io/#/room/#heliopython:openastronomy.org). -Within a week or so, a PyHC developer will review your PR request and approve it (for now, unconditionally, but after the -PyHC Spring 2020 meeting approval is subject to the standards grades). +Within a week or so, the PyHC Tech Lead will review your PR. As part of this review, the Tech Lead generates a +standards report using the [PyHC Standards Evaluator](https://github.com/heliophysicsPy/pyhc-standards-evaluator)—an +AI tool that evaluates a package against PyHC's standards—and compares it against your self-evaluation. If the report +agrees with your grades, the PR can be merged at the Tech Lead's discretion. If it disagrees, the Tech Lead will +discuss the differences with you in the PR until a final set of grades is agreed upon (the Tech Lead has final say). diff --git a/_pyhc_projects/adding_to_pyhc_project_list.md b/_pyhc_projects/adding_to_pyhc_project_list.md index 4d6e9cb..f2e3fa7 100644 --- a/_pyhc_projects/adding_to_pyhc_project_list.md +++ b/_pyhc_projects/adding_to_pyhc_project_list.md @@ -70,8 +70,11 @@ on your forked repository's GitHub page. This will create a request to merge tho website repository. In this PR, write a short blurb about your project, including the name, a general description of the project, and what grades were assigned for the PyHC standards. If any of the standards fall below the "Good" classification, make sure to provide some remarks about why that is, and what the project's plan is for improvement. As stated in the -reviewing guidelines, at present, no projects will be rejected from the PyHC Project list. However, at the -PyHC Spring 2020 meeting we will set a date by which projects will be kicked off if they have any "Requires improvement" grades. +reviewing guidelines, at present, no projects will be rejected from the PyHC Project list. However, we will +eventually set a date by which projects will be kicked off if they have any "Requires improvement" grades. Feel free to also post about your project and the PR in the [Element chat group](https://app.element.io/#/room/#heliopython:openastronomy.org). -Within a week or so, a PyHC developer will review your PR request and approve it (for now, unconditionally, but after the -PyHC Spring 2020 meeting approval is subject to the standards grades). +Within a week or so, the PyHC Tech Lead will review your PR. As part of this review, the Tech Lead generates a +standards report using the [PyHC Standards Evaluator](https://github.com/heliophysicsPy/pyhc-standards-evaluator)—an +AI tool that evaluates a package against PyHC's standards—and compares it against your self-evaluation. If the report +agrees with your grades, the PR can be merged at the Tech Lead's discretion. If it disagrees, the Tech Lead will +discuss the differences with you in the PR until a final set of grades is agreed upon (the Tech Lead has final say). diff --git a/_pyhc_projects/pyhc_project_grading_guidelines.md b/_pyhc_projects/pyhc_project_grading_guidelines.md index 4d5a703..84e1141 100644 --- a/_pyhc_projects/pyhc_project_grading_guidelines.md +++ b/_pyhc_projects/pyhc_project_grading_guidelines.md @@ -10,8 +10,8 @@ with respect to how well their project stacks up to each of the review standards If a project's grade for a standard falls below the "Good" classification, the reviewer should provide some remarks about why that is, and what the project's plan is for improvement. -At present, no projects will be rejected from the PyHC Project list. However, at the PyHC Spring 2020 meeting we will -set a date by which projects will be kicked off if they have any "Requires improvement" grades. +At present, no projects will be rejected from the PyHC Project list. However, we will eventually set a date by which +projects will be kicked off if they have any "Requires improvement" grades. We will also set up a timeline for which projects are 1) informed they are in danger of being kicked off and 2) given time to fix the problematic categories. @@ -20,7 +20,7 @@ A more detailed description of a review's grading colors is shown below. - +
Requires improvementAt present, we won't reject any projects that have a standard with this grade, however, projects are strongly encouraged to improve. Note that this is going to change in the latter part of 2020.At present, we won't reject any projects that have a standard with this grade, however, projects are strongly encouraged to improve. Note that this is going to change in the future.
Partially met