Skip to content

Commit 08bcee2

Browse files
Jammy2211Jammy2211
authored
Merge pull request #651 from PyAutoLabs/claude/g-heart-green-fable-opus-uuiaqf
chore: normalise all tracked text files to LF + enforce via .gitattributes
2 parents cf6ed5f + b7baa4d commit 08bcee2

115 files changed

Lines changed: 18281 additions & 18276 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitattributes‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
# Shell scripts must keep LF endings — a CRLF shebang breaks execution on HPC/Linux.
2-
*.sh eol=lf
1+
# All files use Unix line endings (LF) — see AGENTS.md. text=auto lets git
2+
# detect binaries; eol=lf normalises every text file on checkout and checkin,
3+
# subsuming the earlier targeted shebang/script rules. Tree-wide CRLF
4+
# normalisation landed alongside this file (2026-07-25).
5+
* text=auto eol=lf
6+
# Archived historical PR patches must stay byte-exact for git apply.
7+
patches/** -text

‎.readthedocs.yaml‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
version: 2
2-
3-
build:
4-
os: ubuntu-22.04
5-
tools:
6-
python: "3.12"
7-
8-
python:
9-
install:
10-
- method: pip
11-
path: .
12-
extra_requirements:
13-
- docs
14-
15-
sphinx:
16-
configuration: docs/conf.py
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.12"
7+
8+
python:
9+
install:
10+
- method: pip
11+
path: .
12+
extra_requirements:
13+
- docs
14+
15+
sphinx:
16+
configuration: docs/conf.py
1717
fail_on_warning: false

‎CODE_OF_CONDUCT.md‎

Lines changed: 306 additions & 306 deletions
Large diffs are not rendered by default.

‎CONTRIBUTING.md‎

Lines changed: 144 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -1,144 +1,144 @@
1-
# AI-Assisted Development
2-
3-
This project uses an AI-first development workflow. Most features, bug fixes, and improvements are implemented through AI coding agents (Claude Code, GitHub Copilot, OpenAI Codex) working from structured issue descriptions.
4-
5-
## How It Works
6-
7-
1. **Issues are the starting point** — Every task begins as a GitHub issue with a structured format: an overview, a human-readable plan, a detailed implementation plan (in a collapsible block), and optionally the original prompt that generated the issue.
8-
9-
2. **AI agents pick up issues** — Issues can be assigned to AI coding agents (e.g. GitHub Copilot) which read the issue description, `AGENTS.md`, and `CLAUDE.md` for context, then implement the changes autonomously.
10-
11-
3. **Human review** — All AI-generated pull requests are reviewed by maintainers before merging.
12-
13-
## Maintainer Workflow
14-
15-
Maintainer-driven dev work starts as a prompt file in
16-
**[PyAutoPrompt](https://github.com/PyAutoLabs/PyAutoPrompt)** — the public
17-
workflow repo that hosts the PyAuto task registry and the prompt-coupled
18-
Claude Code skills. The pipeline:
19-
20-
1. Write the task as `PyAutoPrompt/<category>/<name>.md` (free-form markdown
21-
describing what to do, with `@RepoName/path/to/file.py` references).
22-
2. `/start_dev <category>/<name>.md` — reads the prompt, audits the code,
23-
drafts the GitHub issue you see in this repo, and files it.
24-
3. `/start_library` or `/start_workspace` — opens a feature worktree under
25-
`~/Code/PyAutoLabs-wt/<task-name>/`.
26-
4. `/ship_library` / `/ship_workspace` — runs tests, opens the PR, and
27-
tracks state in `PyAutoPrompt/active.md`.
28-
29-
External contributors don't need PyAutoPrompt access — open an issue using
30-
the templates in this repo and the same machinery handles it on our end.
31-
32-
## Creating an Issue
33-
34-
When opening an issue, please use the provided issue templates. The **Feature / Task Request** template follows our standard format:
35-
36-
- **Overview** — What and why, in 2-4 sentences
37-
- **Plan** — High-level bullet points (human-readable)
38-
- **Detailed implementation plan** — File paths, steps, key files (in a collapsible block)
39-
- **Original Prompt** — If you used an AI to help draft the issue, include the original prompt
40-
41-
If your feature involves a specific calculation, algorithm, or small piece of functionality — **include example code**. Even a rough script, a working prototype, or a snippet showing the existing behaviour you want to change makes a huge difference. Code examples give AI agents and human contributors concrete context to work from, and dramatically reduce misunderstandings about what you're asking for.
42-
43-
This structure ensures that both human contributors and AI agents can understand and act on the issue effectively.
44-
45-
## Contributing Without AI
46-
47-
Traditional contributions are equally welcome! If you prefer to work without AI tools, simply follow the development setup and pull request guidelines below. The issue templates are helpful for any contributor, AI or human.
48-
49-
---
50-
51-
## Community Guidelines
52-
53-
We strive to maintain a welcoming, respectful, and inclusive community. All contributors—whether opening issues, submitting pull requests, reviewing code, or participating in discussions—are expected to follow these guidelines.
54-
55-
- Be respectful and considerate of others.
56-
- Assume good intent and be patient, especially with newcomers.
57-
- Keep feedback constructive and focused on the work, not the person.
58-
- Communicate clearly and professionally.
59-
- Respect maintainers’ time and decisions.
60-
61-
Harassment, discrimination, or abusive behavior of any kind will not be tolerated.
62-
63-
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
64-
65-
### Reporting concerns
66-
If you experience or witness behavior that violates these guidelines or the Code of Conduct, please contact the project maintainers privately.
67-
68-
69-
# Contributing
70-
71-
Contributions are welcome and greatly appreciated!
72-
73-
## Types of Contributions
74-
75-
### Report Bugs
76-
77-
Report bugs at https://github.com/PyAutoLabs/PyAutoLens/issues
78-
79-
If you are playing with the PyAutoLens library and find a bug, please
80-
reporting it including:
81-
82-
* Your operating system name and version.
83-
* Any details about your Python environment.
84-
* Detailed steps to reproduce the bug.
85-
86-
### Propose New Features
87-
88-
The best way to send feedback is to open an issue at
89-
https://github.com/PyAutoLabs/PyAutoLens
90-
with tag *enhancement*.
91-
92-
If you are proposing a nnew feature:
93-
94-
* Explain in detail how it should work.
95-
* Keep the scope as narrow as possible, to make it easier to implement.
96-
97-
### Implement Features
98-
Look through the Git issues for operator or feature requests.
99-
Anything tagged with *enhancement* is open to whoever wants to
100-
implement it.
101-
102-
### Add Examples or improve Documentation
103-
Writing new features is not the only way to get involved and
104-
contribute. Create examples with existing features as well
105-
as improving the documentation of existing operators is as important
106-
as making new non-linear searches and very much encouraged.
107-
108-
109-
## Getting Started to contribute
110-
111-
Ready to contribute?
112-
113-
1. Follow the installation instructions for installing **PyAutoLens** (and parent projects) from source root
114-
on our [readthedocs](https://pyautolens.readthedocs.io/en/latest/installation/source.html).
115-
116-
2. Create a feature branch for local development (for **PyAutoLens** and every parent project where changes are implemented):
117-
```
118-
git checkout -b feature/name-of-your-branch
119-
```
120-
Now you can make your changes locally.
121-
122-
3. When you're done making changes, check that old and new tests pass successfully:
123-
```
124-
cd PyAutoLens/test_autolens
125-
python3 -m pytest
126-
```
127-
128-
4. Commit your changes and push your branch to GitHub::
129-
```
130-
git add .
131-
git commit -m "Your detailed description of your changes."
132-
git push origin feature/name-of-your-branch
133-
```
134-
Remember to add ``-u`` when pushing the branch for the first time.
135-
136-
5. Submit a pull request through the GitHub website.
137-
138-
139-
### Pull Request Guidelines
140-
141-
Before you submit a pull request, check that it meets these guidelines:
142-
143-
1. The pull request should include new tests for all the core routines that have been developed.
144-
2. If the pull request adds functionality, the docs should be updated accordingly.
1+
# AI-Assisted Development
2+
3+
This project uses an AI-first development workflow. Most features, bug fixes, and improvements are implemented through AI coding agents (Claude Code, GitHub Copilot, OpenAI Codex) working from structured issue descriptions.
4+
5+
## How It Works
6+
7+
1. **Issues are the starting point** — Every task begins as a GitHub issue with a structured format: an overview, a human-readable plan, a detailed implementation plan (in a collapsible block), and optionally the original prompt that generated the issue.
8+
9+
2. **AI agents pick up issues** — Issues can be assigned to AI coding agents (e.g. GitHub Copilot) which read the issue description, `AGENTS.md`, and `CLAUDE.md` for context, then implement the changes autonomously.
10+
11+
3. **Human review** — All AI-generated pull requests are reviewed by maintainers before merging.
12+
13+
## Maintainer Workflow
14+
15+
Maintainer-driven dev work starts as a prompt file in
16+
**[PyAutoPrompt](https://github.com/PyAutoLabs/PyAutoPrompt)** — the public
17+
workflow repo that hosts the PyAuto task registry and the prompt-coupled
18+
Claude Code skills. The pipeline:
19+
20+
1. Write the task as `PyAutoPrompt/<category>/<name>.md` (free-form markdown
21+
describing what to do, with `@RepoName/path/to/file.py` references).
22+
2. `/start_dev <category>/<name>.md` — reads the prompt, audits the code,
23+
drafts the GitHub issue you see in this repo, and files it.
24+
3. `/start_library` or `/start_workspace` — opens a feature worktree under
25+
`~/Code/PyAutoLabs-wt/<task-name>/`.
26+
4. `/ship_library` / `/ship_workspace` — runs tests, opens the PR, and
27+
tracks state in `PyAutoPrompt/active.md`.
28+
29+
External contributors don't need PyAutoPrompt access — open an issue using
30+
the templates in this repo and the same machinery handles it on our end.
31+
32+
## Creating an Issue
33+
34+
When opening an issue, please use the provided issue templates. The **Feature / Task Request** template follows our standard format:
35+
36+
- **Overview** — What and why, in 2-4 sentences
37+
- **Plan** — High-level bullet points (human-readable)
38+
- **Detailed implementation plan** — File paths, steps, key files (in a collapsible block)
39+
- **Original Prompt** — If you used an AI to help draft the issue, include the original prompt
40+
41+
If your feature involves a specific calculation, algorithm, or small piece of functionality — **include example code**. Even a rough script, a working prototype, or a snippet showing the existing behaviour you want to change makes a huge difference. Code examples give AI agents and human contributors concrete context to work from, and dramatically reduce misunderstandings about what you're asking for.
42+
43+
This structure ensures that both human contributors and AI agents can understand and act on the issue effectively.
44+
45+
## Contributing Without AI
46+
47+
Traditional contributions are equally welcome! If you prefer to work without AI tools, simply follow the development setup and pull request guidelines below. The issue templates are helpful for any contributor, AI or human.
48+
49+
---
50+
51+
## Community Guidelines
52+
53+
We strive to maintain a welcoming, respectful, and inclusive community. All contributors—whether opening issues, submitting pull requests, reviewing code, or participating in discussions—are expected to follow these guidelines.
54+
55+
- Be respectful and considerate of others.
56+
- Assume good intent and be patient, especially with newcomers.
57+
- Keep feedback constructive and focused on the work, not the person.
58+
- Communicate clearly and professionally.
59+
- Respect maintainers’ time and decisions.
60+
61+
Harassment, discrimination, or abusive behavior of any kind will not be tolerated.
62+
63+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold it.
64+
65+
### Reporting concerns
66+
If you experience or witness behavior that violates these guidelines or the Code of Conduct, please contact the project maintainers privately.
67+
68+
69+
# Contributing
70+
71+
Contributions are welcome and greatly appreciated!
72+
73+
## Types of Contributions
74+
75+
### Report Bugs
76+
77+
Report bugs at https://github.com/PyAutoLabs/PyAutoLens/issues
78+
79+
If you are playing with the PyAutoLens library and find a bug, please
80+
reporting it including:
81+
82+
* Your operating system name and version.
83+
* Any details about your Python environment.
84+
* Detailed steps to reproduce the bug.
85+
86+
### Propose New Features
87+
88+
The best way to send feedback is to open an issue at
89+
https://github.com/PyAutoLabs/PyAutoLens
90+
with tag *enhancement*.
91+
92+
If you are proposing a nnew feature:
93+
94+
* Explain in detail how it should work.
95+
* Keep the scope as narrow as possible, to make it easier to implement.
96+
97+
### Implement Features
98+
Look through the Git issues for operator or feature requests.
99+
Anything tagged with *enhancement* is open to whoever wants to
100+
implement it.
101+
102+
### Add Examples or improve Documentation
103+
Writing new features is not the only way to get involved and
104+
contribute. Create examples with existing features as well
105+
as improving the documentation of existing operators is as important
106+
as making new non-linear searches and very much encouraged.
107+
108+
109+
## Getting Started to contribute
110+
111+
Ready to contribute?
112+
113+
1. Follow the installation instructions for installing **PyAutoLens** (and parent projects) from source root
114+
on our [readthedocs](https://pyautolens.readthedocs.io/en/latest/installation/source.html).
115+
116+
2. Create a feature branch for local development (for **PyAutoLens** and every parent project where changes are implemented):
117+
```
118+
git checkout -b feature/name-of-your-branch
119+
```
120+
Now you can make your changes locally.
121+
122+
3. When you're done making changes, check that old and new tests pass successfully:
123+
```
124+
cd PyAutoLens/test_autolens
125+
python3 -m pytest
126+
```
127+
128+
4. Commit your changes and push your branch to GitHub::
129+
```
130+
git add .
131+
git commit -m "Your detailed description of your changes."
132+
git push origin feature/name-of-your-branch
133+
```
134+
Remember to add ``-u`` when pushing the branch for the first time.
135+
136+
5. Submit a pull request through the GitHub website.
137+
138+
139+
### Pull Request Guidelines
140+
141+
Before you submit a pull request, check that it meets these guidelines:
142+
143+
1. The pull request should include new tests for all the core routines that have been developed.
144+
2. If the pull request adds functionality, the docs should be updated accordingly.

‎LICENSE‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
MIT License
2-
3-
Copyright (c) 2018 Jammy2211
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
MIT License
2+
3+
Copyright (c) 2018 Jammy2211
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)