pyOCD style guide and tools
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 560
- Avg merge
- 1h 41m
- Merged PRs (30d)
- 3
Description
To make contributions easier, pyOCD needs a recommended style guide/naming convention, along with tools to easily check these and auto formatting source.
My preference is that the code is compliant to pep8 where reasonable. Contributors would be encouraged to follow the conventions, but would not be required to. This could also be automated to post warnings on pull requests if the code has pep8 inconsistencies.
Development IDEs
-Eclipse with pyDev - allows auto formatting, and highlighting of code that is non-pep8 compliant. It also is able to catch errors, such as referencing variables that doesn't exist
-pyCharm
Code style checking tools:
-pep8
-pylint
Auto formatting Tools
-autopep8
If anyone has other ideas or preferences please respond to this issue.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the issue discussion and its proposed PEP8, pep8, pylint, and autopep8 options; the work is done when pyOCD has an agreed style guide and a defined way to check or format contributions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100