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
- Files containing `File generated from our OpenAPI spec` at the top are generated; do not edit. Similarly, any code block starting with `The beginning of the section generated from our OpenAPI spec` is generated and should not be edited directly.
28
+
- If something in a generated file/range needs to be updated, add a summary of the change to your report but don't attempt to edit it directly.
29
+
- Resource model classes under `src/main/java/com/stripe/model/` are largely generated.
30
+
- The `net/` package (HTTP client, headers, request/response) is NOT generated.
31
+
32
+
## Conventions
33
+
34
+
- Uses Java's built-in `HttpURLConnection` for HTTP
35
+
- Requires JDK 17 to build
36
+
- Gradle build system
37
+
- Work is not complete until `just test` passes
38
+
39
+
### Comments
40
+
41
+
- Comments MUST only be used to:
42
+
1. Document a function
43
+
2. Explain the WHY of a piece of code
44
+
3. Explain a particularly complicated piece of code
45
+
- Comments NEVER should be used to:
46
+
1. Say what used to be there. That's no longer relevant!
47
+
2. Explain the WHAT of a piece of code (unless it's very non-obvious)
48
+
49
+
It's ok not to put comments on/in a function if their addition wouldn't meaningfully clarify anything.
0 commit comments