|
| 1 | +# Thank you for contributing to SunPy |
| 2 | + |
| 3 | +## 🚨 IMPORTANT 🚨 |
| 4 | + |
| 5 | +We know that working on code and submitting pull requests takes effort, and we appreciate your time. |
| 6 | +Thank you. |
| 7 | + |
| 8 | +[Please be aware that everyone has to follow our code of conduct](https://sunpy.org/coc) |
| 9 | + |
| 10 | +[Furthermore, you might need to check with your work place if you are allowed to contribute code](https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html) |
| 11 | + |
| 12 | +- Please try to create an issue _before_ creating a Pull Request. |
| 13 | +- Please use the following Git commit message style |
| 14 | + - Use the future tense ("Adds feature" not "Added feature") |
| 15 | + - Limit the first line to 72 characters or less |
| 16 | +- **Do not post the output from Large Language Models or similar generative AI as code or comments on GitHub or any other platform.** |
| 17 | + If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. |
| 18 | + See our documentation on fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). |
| 19 | + |
| 20 | +We have several automatic features that run when a pull request is open. |
| 21 | +They can appear daunting but do not worry about them! |
| 22 | +[This a brief explanation of them.](https://docs.sunpy.org/en/latest/dev_guide/contents/pr_review_procedure.html#continuous-integration) |
| 23 | + |
| 24 | +## ↑👆 DELETE above _before_ submitting 👆↑ |
| 25 | + |
| 26 | +## PR Description |
| 27 | + |
| 28 | +<!-- |
| 29 | +Please include a summary of the changes and which issue will be addressed. |
| 30 | +Please also include relevant motivation and context. |
| 31 | +--> |
| 32 | + |
| 33 | +## AI Assistance Disclosure |
| 34 | + |
| 35 | +<!-- |
| 36 | +To support transparency and sustainable collaboration, please indicate whether AI-assisted tools were used in preparing this pull request. |
| 37 | +Your pull request will not be reviewed until you have completed this checklist. |
| 38 | +Removing this checklist may result in your pull request being automatically closed without a review. |
| 39 | +For further details see our documentation on the fair and appropriate [usage of AI](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). |
| 40 | +--> |
| 41 | + |
| 42 | +AI tools were used for: |
| 43 | +- [ ] Code generation (e.g., when writing an implementation or fixing a bug) |
| 44 | +- [ ] Test/benchmark generation |
| 45 | +- [ ] Documentation (including examples) |
| 46 | +- [ ] Research and understanding |
| 47 | +- [ ] No AI tools were used |
| 48 | + |
| 49 | +> Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability. |
0 commit comments