Community Guidelines#

This section describes a list of requirements and guidelines that should be followed by any contributor to Gammapy. We warmly welcome new contributors to Gammapy.

  • Any Gammapy activity should respect the Code of Conduct of the project.

  • If you are new to Gammapy please read the :ref:<new-contributor> steps in addition the ones outlined here.

  • Before beginning work on a pull request (PR), you should comment on an issue (ideally labeled package-novice) to express your interest, and propose your intended approach there. If you have a specific idea (e.g. you notice a bug or want to propose a new feature) you should open an issue before a PR.

  • Opening a PR without prior discussion is generally not accepted.

  • All authors must follow the the authorship policy outlined here and ensure their git account is correctly configured.

  • All authors should read and promote the Gammapy citation scheme.

  • While we welcome new contributors, contributions should be meaningful. PRs consisting only of very minor documentation changes are discouraged.

  • Please follow the AI guidelines outlined in detail below.

Any PRs not adhering to these guidelines will not be accepted.

For further details about contributing to Gammapy, please familiarise yourself with the Developer Guide to make sure PRs comply with our coding standards and style.

AI Guidelines#

We recognise that artificial intelligence (AI), in particular Large language models (LLMs), is a modern tool in many aspects of the world and acknowledge its wide use within software development. We list below a number of guidelines for utilising AI:

  • All PRs must include a clear disclosure of any AI usage

  • Contributions must comply with Gammapy’s license rules (BSD 3-Clause “New” or “Revised” License) and Developer Certificate of Origin (DCO)

  • The author needs to be able to explain the changes introduced

  • Avoid directly copy pasting AI generated content for either the PR text or content

  • Purely automated PRs will be closed without discussion

Any PRs not adhering to these guidelines will not be accepted.

In summary, we ask that you keep the two following key points in mind:

  • Never let an LLM speak for you.

  • Never let an LLM think for you.