Skip to content

Commit 7c216e5

Browse files
pyproject version upgrade and contributing doc update
1 parent c7ad45f commit 7c216e5

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

docs/CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ If you find an issue with this package, please create an issue in GitHub. If you
44

55
## Adding New Functionality or Fixing Bugs
66

7-
If you are adding a new endpoint, make sure to update the API coverage list where we keep track of the HCP Terraform APIs that this SDK supports.
8-
97
If you are making relevant changes worth communicating to our users, please include a note about it in our `CHANGELOG.md`. You can include it as part of the PR where you are submitting your changes.
108

119
`CHANGELOG.md` should have the next minor version listed as `# v0.X.0 (Unreleased)` and any changes can go under there. But if you feel that your changes are better suited for a patch version (like a critical bug fix), you may list a new section for this version. You should repeat the same formatting style introduced by previous versions.
@@ -42,6 +40,7 @@ make test
4240
* A resource class should cover one RESTful resource, which sometimes involves two or more endpoints.
4341
* Each resource class must be registered in the `TFEClient` class in `client.py`.
4442
* You'll need to add unit tests that cover each method of the resource class with mocked responses.
43+
* Each API resource implementation must have a corresponding example file added to the `examples/` directory demonstrating its usage.
4544
* Option classes serve as a proxy for either passing query params or request bodies:
4645
- `ListOptions` and `ReadOptions` are values passed as query parameters.
4746
- `CreateOptions` and `UpdateOptions` represent the request body.
@@ -559,7 +558,6 @@ Before submitting a PR, ensure:
559558
- [ ] All tests pass (`make test`)
560559
- [ ] New functionality has unit tests
561560
- [ ] CHANGELOG.md is updated
562-
- [ ] API coverage list is updated (if adding endpoints)
563561
- [ ] Example file is added/updated (if adding resource)
564562
- [ ] Docstrings are added to new classes/methods
565563

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "pytfe"
7-
version = "0.1.0"
7+
version = "0.1.1"
88
description = "Official Python SDK for HashiCorp Terraform Cloud / Terraform Enterprise (TFE) API v2"
99
readme = "README.md"
1010
license = { text = "MPL-2.0" }

0 commit comments

Comments
 (0)