You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@ If you find an issue with this package, please create an issue in GitHub. If you
4
4
5
5
## Adding New Functionality or Fixing Bugs
6
6
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
-
9
7
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.
10
8
11
9
`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
42
40
* A resource class should cover one RESTful resource, which sometimes involves two or more endpoints.
43
41
* Each resource class must be registered in the `TFEClient` class in `client.py`.
44
42
* 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.
45
44
* Option classes serve as a proxy for either passing query params or request bodies:
46
45
-`ListOptions` and `ReadOptions` are values passed as query parameters.
47
46
-`CreateOptions` and `UpdateOptions` represent the request body.
@@ -559,7 +558,6 @@ Before submitting a PR, ensure:
559
558
-[ ] All tests pass (`make test`)
560
559
-[ ] New functionality has unit tests
561
560
-[ ] CHANGELOG.md is updated
562
-
-[ ] API coverage list is updated (if adding endpoints)
563
561
-[ ] Example file is added/updated (if adding resource)
0 commit comments