Skip to content

Commit 88e0087

Browse files
MaxGhenisclaude
andcommitted
Add changelog entry and development guidelines
- Add changelog_entry.yaml for taxcalc removal - Create CLAUDE.md with development guidelines for future work - Ensure files end with newlines to pass lint checks 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e9e7a35 commit 88e0087

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Claude Development Guidelines for microdf
2+
3+
## Code Style
4+
- All files must end with a newline character
5+
- Run `make lint` before committing to catch style issues
6+
7+
## Changelog Requirements
8+
- Every PR must include a `changelog_entry.yaml` file at the root
9+
- Format:
10+
```yaml
11+
- bump: patch|minor|major
12+
changes:
13+
added|changed|removed|fixed:
14+
- Description of change
15+
```
16+
- The file must not be empty and must end with a newline
17+
18+
## Testing
19+
- Run tests with: `python3 -m pytest microdf/tests/ -v`
20+
- Ensure all tests pass before creating a PR
21+
22+
## Pull Request Process
23+
1. Create a feature branch from master
24+
2. Make changes and ensure they follow code style guidelines
25+
3. Add a changelog entry
26+
4. Create PR with descriptive title and body
27+
5. PRs should close related issues using "Closes #XXX" in the body
28+
29+
## Dependencies
30+
- Dependencies are managed in `pyproject.toml`
31+
- Optional dependencies go in `[project.optional-dependencies]`
32+
- When removing dependencies, also remove from `microdf/_optional.py` VERSIONS dict
33+
34+
## Documentation
35+
- Documentation notebooks are in `docs/` directory
36+
- When removing functionality, consider impact on documentation examples

changelog_entry.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- bump: minor
2+
changes:
3+
removed:
4+
- Remove all taxcalc functionality and dependencies from the package.
5+
- Delete taxcalc.py module and associated test file.
6+
- Remove taxcalc from optional dependencies in pyproject.toml.

0 commit comments

Comments
 (0)