Skip to content

Commit d6c28cd

Browse files
author
hallong
committed
docs: add development standards section to README
1 parent 9cb0fed commit d6c28cd

File tree

1 file changed

+52
-4
lines changed

1 file changed

+52
-4
lines changed

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4343
[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)
44-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
44+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
4545
</p>
4646

4747
<p align="center">Python API for Photoshop.</p>
@@ -72,7 +72,7 @@ pip install photoshop_python_api
7272
```
7373

7474

75-
Since it uses COM (Component Object Model) connect Photoshop, it can be used
75+
Since it uses COM (Component Object Model) connect Photoshop, it can be used
7676
in any DCC software with a python interpreter.
7777

7878

@@ -183,8 +183,8 @@ Contributions of any kind are welcome!
183183
how to get Photoshop program ID
184184
-------------------------------
185185
```PS>
186-
Get-ChildItem "HKLM:\SOFTWARE\Classes" |
187-
?{ ($_.PSChildName -match "^[a-z]+\.[a-z]+(\.\d+)?$") -and ($_.GetSubKeyNames() -contains "CLSID") } |
186+
Get-ChildItem "HKLM:\SOFTWARE\Classes" |
187+
?{ ($_.PSChildName -match "^[a-z]+\.[a-z]+(\.\d+)?$") -and ($_.GetSubKeyNames() -contains "CLSID") } |
188188
?{ $_.PSChildName -match "Photoshop.Application" } | ft PSChildName
189189
```
190190
![get_program_id](https://i.imgur.com/UwPN7qq.png)
@@ -208,3 +208,51 @@ Useful links
208208
- http://www.tonton-pixel.com/scripts/utility-scripts/get-equivalent-id-code/index.html
209209
- https://github.com/Adobe-CEP/Samples/tree/master/PhotoshopEvents
210210
- https://evanmccall.wordpress.com/2015/03/09/how-to-develop-photoshop-tools-in-python
211+
212+
213+
Development Standards
214+
--------------------
215+
216+
This project follows these development standards to maintain code quality and consistency:
217+
218+
### Code Style
219+
220+
- **Python**: We follow the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) with some modifications:
221+
- Line length: 120 characters (configured in `.flake8` and `pyproject.toml`)
222+
- Docstrings: Google style (configured in `.flake8`)
223+
- Quotes: Double quotes as default (configured in `.flake8`)
224+
225+
- **Formatting Tools**:
226+
- [Black](https://black.readthedocs.io/): For code formatting
227+
- [isort](https://pycqa.github.io/isort/): For import sorting
228+
- [flake8](https://flake8.pycqa.org/): For style enforcement
229+
230+
### Git Workflow
231+
232+
- **Commit Messages**: We use [Conventional Commits](https://www.conventionalcommits.org/) format
233+
- Format: `<type>(<scope>): <description>`
234+
- Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
235+
- Example: `feat(api): add new layer manipulation method`
236+
237+
- **Branching Strategy**:
238+
- Feature branches: `feature/<feature-name>`
239+
- Bug fixes: `fix/<bug-description>`
240+
- Documentation: `docs/<doc-description>`
241+
242+
### Development Environment
243+
244+
- **Dependencies**: Managed with [Poetry](https://python-poetry.org/)
245+
- **Pre-commit Hooks**: Configured in `.pre-commit-config.yaml`
246+
- **Testing**: Use `pytest` for running tests
247+
248+
### Contributing
249+
250+
1. Fork the repository
251+
2. Create your feature branch
252+
3. Install development dependencies: `poetry install`
253+
4. Install pre-commit hooks: `pre-commit install`
254+
5. Make your changes and ensure tests pass
255+
6. Commit your changes using conventional commit format
256+
7. Push to your branch
257+
8. Create a Pull Request
258+

0 commit comments

Comments
 (0)