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: CHANGELOG.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,10 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
14
14
15
15
- hasura: Forbid using Hasura instances affected by [GHSA-c9rw-rw2f-mj4x](https://github.com/hasura/graphql-engine/security/advisories/GHSA-c9rw-rw2f-mj4x)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,23 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
12
12
13
13
## GitHub
14
14
15
-
- Branch names MUST follow `prefix/short-description` format. Prefixes currently in use: `feat` for features, `fix` for bugfixes, `docs` for documentation, `aux` for miscellaneous, `exp` for experiments.
15
+
- Branch names MUST follow `prefix/short-description` format. Prefixes currently in use: `feat` for features, `fix` for bugfixes, `docs` for documentation, `exp` for experiments, `aux` for everything else.
16
16
- Commits in pull requests MUST be squashed when merging to `master`.
17
17
- Issues and pull requests MUST have a descriptive title; they SHOULD be linked to each other, appropriately labeled, and assigned to maintainers while in progress.
18
18
19
19
## Codestyle
20
20
21
21
- We use the following combo of linters and formatters: `isort`, `black`, `ruff`, `mypy`. All linter checks MUST pass before merging code to `master` (CI will fail otherwise).
22
-
- Single quotes are RECOMMENDED for string literals.
22
+
- Single quotes MUST be used for string literals.
23
23
- Meaningful comments are highly RECOMMENDED to begin with `# NOTE:`, `# TODO:`, or `# FIXME:`.
24
24
- f-string formatting is RECOMMENDED over other methods. Logging is an exception to this rule.
25
25
26
+
## Packaging
27
+
28
+
- All dependencies MUST be declared in `pyproject.toml` file.
29
+
- Non-development dependencies MUST be pinned to non-breaking versions (e.g. `^1.2.3`).
30
+
- Core dependencies that we patch MUST be pinned to specific versions (e.g. `1.2.3`).
31
+
26
32
## Releases
27
33
28
34
- Release versions MUST conform to [Semantic Versioning](https://semver.org/). Releases that introduce breaking changes MUST be major ones.
@@ -44,6 +50,7 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
44
50
## Security
45
51
46
52
- GitHub alerts about dependencies that contain vulnerabilities MUST be investigated and resolved as soon as possible.
53
+
- Security-related bugfixes MUST be mentioned in the changelog under the "Security" section.
47
54
48
55
## Privacy
49
56
@@ -53,7 +60,7 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
53
60
54
61
## Docker images
55
62
56
-
- DipDup dockerfiles use autogenerated `requirements.txt` files. Maintainers SHOULD run `make update` script on every change in dependencies.
63
+
- DipDup dockerfiles use autogenerated `requirements.txt` files. Maintainers MUST run `make update` script on every change in dependencies.
57
64
- Docker images for stable releases MUST be published on Docker Hub. They MAY also be published on GHCR.
58
65
- Maintainers MAY publish arbitrary images on GHCR and remove them when not needed.
charset-normalizer==3.1.0 ; python_version >= "3.10" and python_version < "3.11"
28
28
click==8.1.3 ; python_version >= "3.10" and python_version < "3.11"
29
29
colorama==0.4.6 ; python_version >= "3.10" and python_version < "3.11" and platform_system == "Windows" or python_version >= "3.10" and python_version < "3.11" and sys_platform == "win32"
30
-
comm==0.1.2 ; python_version >= "3.10" and python_version < "3.11"
30
+
comm==0.1.3 ; python_version >= "3.10" and python_version < "3.11"
31
31
cryptography==39.0.2 ; python_version >= "3.10" and python_version < "3.11"
32
32
cytoolz==0.12.1 ; python_version >= "3.10" and python_version < "3.11" and implementation_name == "cpython"
33
33
datamodel-code-generator==0.17.1 ; python_version >= "3.10" and python_version < "3.11"
0 commit comments