Skip to content

Add a feature tranfer template #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-transfer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
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.

### Authorship
Please clarify authorship info, including the names of contributors, and email address/organization if applicable.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down