Skip to content

Updates from the package template #917

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.

Sign up for GitHub

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
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updates from the package template #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .cruft.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "4c87aec25b842ac84ed38a609e89f145b7b0848b",
"commit": "557d3736ee03667e7ba5feb8a50f41cbf0ab3268",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down Expand Up @@ -32,7 +32,7 @@
".github/workflows/sub_package_update.yml"
],
"_template": "https://github.com/sunpy/package-template",
"_commit": "4c87aec25b842ac84ed38a609e89f145b7b0848b"
"_commit": "557d3736ee03667e7ba5feb8a50f41cbf0ab3268"
}
},
"directory": null
Expand Down
23 changes: 22 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,21 @@ Usage of Generative AI
======================

We expect authentic engagement in our community.
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
**Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.**
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.
<<<<<<<
=======
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.

License
-------

This project is Copyright (c) The SunPy Community and licensed under
the terms of the BSD 2-Clause license. This package is based upon
the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`__
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.
>>>>>>>

Acknowledging ndcube
====================
Expand Down Expand Up @@ -76,4 +89,12 @@ Code of Conduct

When you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.

<<<<<<<
.. _Code of Conduct: https://sunpy.org/coc
=======
Note: This disclaimer was originally written by
`Adrienne Lowe <https://github.com/adriennefriend>`__ for a
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`__, and was adapted by
ndcube based on its use in the README file for the
`MetPy project <https://github.com/Unidata/MetPy>`__.
>>>>>>>