diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9711abbf2..c7ff02be5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1 +1,4 @@ Detailed contribution guidelines are available as part of our documentation at https://axelrod.readthedocs.io/en/latest/how-to/contributing/index.html + +Our policy on the use of AI tools is at +https://axelrod.readthedocs.io/en/latest/how-to/contributing/use_of_ai_tools.html diff --git a/README.rst b/README.rst index 7ef17c1fe..9120bf4bb 100644 --- a/README.rst +++ b/README.rst @@ -110,16 +110,15 @@ Examples Contributing ------------ -All artisanal contributions are welcome! - -*Code Generation Policy*: - -*We do not accept any content that has been created with the assistance of generative code tools.* +All contributions are welcome! You can find helpful instructions about contributing in the documentation: https://axelrod.readthedocs.io/en/stable/how-to/contributing/index.html +Our policy on the use of AI tools is at +https://axelrod.readthedocs.io/en/stable/how-to/contributing/use_of_ai_tools.html + Publications ------------ diff --git a/docs/how-to/contributing/index.rst b/docs/how-to/contributing/index.rst index 7dae3a3ec..80998fc33 100644 --- a/docs/how-to/contributing/index.rst +++ b/docs/how-to/contributing/index.rst @@ -10,6 +10,7 @@ Contents: :maxdepth: 2 guidelines.rst + use_of_ai_tools.rst setting_up_the_environment.rst strategy/index.rst library/index.rst diff --git a/docs/how-to/contributing/use_of_ai_tools.rst b/docs/how-to/contributing/use_of_ai_tools.rst new file mode 100644 index 000000000..69022c5c7 --- /dev/null +++ b/docs/how-to/contributing/use_of_ai_tools.rst @@ -0,0 +1,21 @@ +Use of AI tools +=============== + +You may use AI tools (code assistants, large language models) when +contributing to the library. If you do, the description of your pull request +must say which parts were AI-generated. Autocomplete and spelling fixes do not +count. + +We also require the following: + +- You are responsible for your contribution: you should understand it, have + tested it and be able to explain every line. +- Keep it small and self-contained. Generated code should be documented, + readable and isolated (for example one strategy class plus its tests) so that + it can be cleanly removed later. We will not accept large volumes of generated + code. +- A new strategy should either come from the published literature, with a + reference in the :ref:`bibliography`, or be qualitatively new. A generated + variant of a strategy already in the :ref:`strategies-index` adds no value. +- The maintainers do not commit to maintaining AI-generated code, and we may + remove it if it becomes a maintenance burden.