diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 37ce7be..74bc266 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,10 +7,19 @@ version: 2 # Set the version of Python and other tools you might need build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: - python: "3.10" - + python: "3.13" + jobs: + pre_install: + - pip install --upgrade pip + - pip install --upgrade --upgrade-strategy only-if-needed --group doc . + # build: + # html: + # - python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html + post_build: + - echo "Command run at 'post_build' step" + - echo `date` # Build documentation in the docs/ directory with Sphinx sphinx: @@ -23,7 +32,6 @@ formats: # FIXME: We should be installing the `doc` dependency group and not the `doc` # extra. -#Optionally declare the Python requirements required to build your docs python: install: - method: pip diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dafc1c3..cfe68bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ -# Contributing to ptulsconv +# Contributing + +Contributions to `ptulsconv` are welcome! ## Testing @@ -7,3 +9,35 @@ Before submitting PRs or patches, please make sure your branch passes all of the ```sh ~/ptulsconv$ pytest ``` + +## Regarding use of Agents + +`ptulsconv` is an open-source project that is offered free for no commerical gain, and +is developed and maintained for educational and creative reasons. + +If you use an agent or LLM to produce code for it you are missing out on the benefits +of contributing to an open-source project, particularly community, collaboration with +other developers and designers, and being able to learn and experiment without the +burden of deadlines or worrying about business cases or profits. + +This project is supposed to be fun, do not let machines have fun for you. + +We can't prevent you from using LLMs to contribute to this project but we ask you +abide by the following eitiquette when doing so: + +* All communication with the maintainers must be written by a human in their own + voice. Never use an LLM to craft thread comments, discussion posts, issues, emails + or other correspondence with other developers or the maintainers. +* PRs must be submitted by a person. Do not allow an agent to submit its own PRs to + this project. +* Especially if you are a new contributor to this project, please submit only one PR + at a time and please restrict the subject matter of the PR to a specific unit, + module or tool. All submissions have to be reviewed and understood by the + maintainers before they can be merged. + +Obviously we can't verify if you follow all of these rules but certain telltale +traits of LLM-predicted text or code will raise a flag: lack of brevity in +descriptions or code comments, large amounts of text describing your process or +steps that add little to understanding the changes you've made, use of an +obsequious tone or being excessively accomodating, immediately doing requests +without further discussion or clarifications.