16 Commits

Author SHA1 Message Date
32191791c6 Twiddling with RtD 2025-09-20 23:00:49 -07:00
1ff910e4d2 Doc notes 2025-09-20 22:34:58 -07:00
0e8a77f548 removing flake8 file 2025-09-20 22:26:21 -07:00
Jamie Hardt
7058397f6f Update __init__.py 2025-09-20 22:24:10 -07:00
Jamie Hardt
16d7befd9f Update __init__.py 2025-09-20 22:21:56 -07:00
Jamie Hardt
2a3f4a7c18 Update python-package.yml 2025-09-20 22:19:14 -07:00
d7fff23e5e Tweaking workflow 2025-09-20 22:12:55 -07:00
Jamie Hardt
757c3171e7 Merge branch 'master' into feat-uv 2025-09-20 22:10:15 -07:00
48dd7de07e Changing to ruff linter 2025-09-20 22:07:33 -07:00
2a69bf47c8 Version number in banner 2025-09-20 10:02:44 -07:00
01d2374a9b Merge branch 'feat-uv' of https://github.com/iluvcapra/ptulsconv into feat-uv 2025-09-20 09:47:07 -07:00
68e7eb89a9 Twiddle 2025-09-20 09:46:46 -07:00
Jamie Hardt
517fe3526a Update python-package.yml
Removed redundant flake8 run
2025-09-20 08:56:34 -07:00
7789c0df4c Updating github workflow 2025-09-19 10:43:20 -07:00
d97dcc3e08 Updated Flake8 settings 2025-09-19 10:41:41 -07:00
615b2b5a2a Migrating to uv build and manager 2025-09-19 10:36:28 -07:00
2 changed files with 6 additions and 41 deletions

View File

@@ -7,16 +7,15 @@ version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-lts-latest
os: ubuntu-20.04
tools:
python: "3.13"
python: "3.10"
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
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`

View File

@@ -1,6 +1,4 @@
# Contributing
Contributions to `ptulsconv` are welcome!
# Contributing to ptulsconv
## Testing
@@ -9,35 +7,3 @@ 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.