← spm1d
Contributing
Bug reports
- Check whether the bug has already been reported in the relevant package's Issues page:
- If no relevant issue exists, open a new issue with a concise, clear title and a minimal reproducible example.
Bug fixes
- Open a pull request (PR) with your fix.
- You may use AI to develop the fix but AI must not open the PR; see the AI policy below.
- Describe the problem and the solution clearly and concisely in your PR message, along with relevant issue number(s).
Cosmetic changes
Purely cosmetic changes (for example whitespace or formatting) that add nothing to stability, functionality or testability should generally be avoided, unless they substantially improve readability.
New features
Suggest the change in the package's issues first, and do not open a pull request until an spm1d.org moderator has provided positive feedback.
Several new features are already in development, so the moderators will provide feedback regarding ongoing developments to avoid overlapping development.
AI policy
Several components of spm1d.org software use AI tools to assist with development (see AI use). Contributors may use AI under the following conditions:
- Do not generate pull requests using AI. All AI-generated PRs will be rejected.
- You take full responsibility for your contribution, regardless of whether AI assistance was used.
- Full disclosure required. If you used AI, say so in your pull request: which tool(s), how you used it, and which parts it generated.
- You must have the right to submit your contribution under the package's license (GPL-3.0), including all AI-generated code.
- Pull requests that do not follow this policy may be rejected without review.
spm1d.org's AI policy follows recently adopted policies from similar scientific Python projects including: NumPy, SciPy and scikit-learn.