Reorganize Deform repo to best practices
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 423
- Forks
- 158
- PR merge metrics
- No merged PRs in 30d
Description
Reorganize the code, emulating Pyramid. This allows only Deform's source to be easily released (currently it includes its tests, which is a sloppy practice).
- docs/
- src/deform/
- tests/
Include only Deform's source code in the release to PyPI, using the spiffy code reorganization.
Originally posted by @stevepiercy in https://github.com/Pylons/deform/issues/472#issuecomment-685741043
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
Compare the repository layout with Pyramid's organization, focusing on docs/, src/deform/, and tests/. Then inspect the existing PyPI release configuration. Done means the repository follows the proposed layout and PyPI contains only Deform's source code, without its tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100