From bf46c505edde96db2aa371a41df9617ce9dc537a Mon Sep 17 00:00:00 2001 From: Qiming Sun Date: Sat, 3 May 2025 11:33:13 -0700 Subject: [PATCH 1/2] Add a feature tranfer template --- .github/ISSUE_TEMPLATE/feature-transfer.md | 35 ++++++++++++++++++++++ CONTRIBUTING.md | 3 +- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/feature-transfer.md diff --git a/.github/ISSUE_TEMPLATE/feature-transfer.md b/.github/ISSUE_TEMPLATE/feature-transfer.md new file mode 100644 index 000000000..31efc5b5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-transfer.md @@ -0,0 +1,35 @@ +--- +name: Feature Transfer to PySCF Core +about: Propose the migration of a feature from PySCF-Forge to the PySCF core repository +title: "[FEATURE TRANSFER] Title of feature transfer proposal" +labels: '' +assignees: '' + +--- + +### Feature Description +Provide a clear and concise description of the feature being proposed for transfer. Include: +- The scientific background or motivation. +- Links to reference papers, original publications, or relevant materials. +- The current status and functionality in PySCF-Forge. +- Any limitations or known issues. + +### Relevant Modules and Files +List all relevant Python modules, C files and C-extension modules involved. Include: +- Existing file names and locations in PySCF-Forge. +- Proposed new file paths or module names in PySCF. +- Any anticipated dependencies on internal APIs or third-party packages. + +### Documentation +Provide links to any existing documentation, tutorials, or demos. +- Link to the corresponding page in https://github.com/pyscf/pyscf.github.io if avaiable. +- If not yet documented, provide a brief plan or link to a draft PR in https://github.com/pyscf/pyscf.github.io . + +### Long-term Maintenance Plan +Assign or propose a long-term maintainer for this feature. + +### Additional Context +Include any further information that may be helpful for reviewing this transfer, such as: +- Benchmark results or performance metrics. +- Related issues or discussions. +- Compatibility considerations with other PySCF components. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e828fdc7..6956f9968 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,8 @@ maintainers at https://github.com/orgs/pyscf/people. After a feature has been added to PySCF-forge for over 6 months, developers can open an issue to request to transfer the feature to the PySCF core branch. -The proposal template can be accessed at (TBD). The proposal will be reviewed +A Feature Transfer Proposal template is available when creating a new GitHub +issue. The proposal will be reviewed during the PySCF board meetings, held approximately every 3 months. If it is decided that the feature is incompatible with the requirements of the core branch, the board may recommend additional modifications, or that the feature be removed from PySCF-forge. From 1138c361060fd7c962a32e89ec75fb9163fe3e9f Mon Sep 17 00:00:00 2001 From: Qiming Sun Date: Fri, 23 May 2025 07:41:59 -0700 Subject: [PATCH 2/2] Add requirements to authorship in feature transfer template --- .github/ISSUE_TEMPLATE/feature-transfer.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature-transfer.md b/.github/ISSUE_TEMPLATE/feature-transfer.md index 31efc5b5b..b00977217 100644 --- a/.github/ISSUE_TEMPLATE/feature-transfer.md +++ b/.github/ISSUE_TEMPLATE/feature-transfer.md @@ -33,3 +33,6 @@ Include any further information that may be helpful for reviewing this transfer, - Benchmark results or performance metrics. - Related issues or discussions. - Compatibility considerations with other PySCF components. + +### Authorship +Please clarify authorship info, including the names of contributors, and email address/organization if applicable.