Skip to content

Commit a584b58

Browse files
📝 improve contrib docs (#145)
This PR improves formatting of the contrib docs and adds a change management note.
1 parent fa23e7c commit a584b58

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.10.6

CONTRIBUTING.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ You can find an example of how mixins are used with `StatementExecutionExt`. The
99
work with the WorkspaceClient using `StatementExecutionExt`. This example can help you understand how mixins work in practice.
1010

1111
Favoring standard libraries over external dependencies, especially in specific contexts like Databricks, is a best practice in software
12-
development. There are several reasons why this approach is encouraged. Standard libraries are typically well-vetted, thoroughly tested,
13-
and maintained by the official maintainers of the programming language or platform. This ensures a higher level of stability and reliability.
14-
External dependencies, especially lesser-known or unmaintained ones, can introduce bugs, security vulnerabilities, or compatibility issues
15-
that can be challenging to resolve. Adding external dependencies increases the complexity of your codebase. Each dependency may have its own
16-
set of dependencies, potentially leading to a complex web of dependencies that can be difficult to manage. This complexity can lead to
17-
maintenance challenges, increased risk, and longer build times. External dependencies can pose security risks. If a library or package has
18-
known security vulnerabilities and is widely used, it becomes an attractive target for attackers. Minimizing external dependencies reduces
19-
the potential attack surface and makes it easier to keep your code secure. Relying on standard libraries enhances code portability. It ensures
20-
your code can run on different platforms and environments without being tightly coupled to specific external dependencies. This is particularly
21-
important in settings like Databricks, where you may need to run your code on different clusters or setups. External dependencies may have their
22-
versioning schemes and compatibility issues. When using standard libraries, you have more control over versioning and can avoid conflicts between
23-
different dependencies in your project. Fewer external dependencies mean faster build and deployment times. Downloading, installing, and managing
24-
external packages can slow down these processes, especially in large-scale projects or distributed computing environments like Databricks.
25-
External dependencies can be abandoned or go unmaintained over time. This can lead to situations where your project relies on outdated or
26-
unsupported code. When you depend on standard libraries, you have confidence that the core functionality you rely on will continue to be maintained
27-
and improved.
12+
development.
13+
14+
There are several reasons why this approach is encouraged:
15+
- Standard libraries are typically well-vetted, thoroughly tested, and maintained by the official maintainers of the programming language or platform. This ensures a higher level of stability and reliability.
16+
- External dependencies, especially lesser-known or unmaintained ones, can introduce bugs, security vulnerabilities, or compatibility issues that can be challenging to resolve. Adding external dependencies increases the complexity of your codebase.
17+
- Each dependency may have its own set of dependencies, potentially leading to a complex web of dependencies that can be difficult to manage. This complexity can lead to maintenance challenges, increased risk, and longer build times.
18+
- External dependencies can pose security risks. If a library or package has known security vulnerabilities and is widely used, it becomes an attractive target for attackers. Minimizing external dependencies reduces the potential attack surface and makes it easier to keep your code secure.
19+
- Relying on standard libraries enhances code portability. It ensures your code can run on different platforms and environments without being tightly coupled to specific external dependencies. This is particularly important in settings like Databricks, where you may need to run your code on different clusters or setups.
20+
- External dependencies may have their versioning schemes and compatibility issues. When using standard libraries, you have more control over versioning and can avoid conflicts between different dependencies in your project.
21+
- Fewer external dependencies mean faster build and deployment times. Downloading, installing, and managing external packages can slow down these processes, especially in large-scale projects or distributed computing environments like Databricks.
22+
- External dependencies can be abandoned or go unmaintained over time. This can lead to situations where your project relies on outdated or unsupported code. When you depend on standard libraries, you have confidence that the core functionality you rely on will continue to be maintained and improved.
2823

2924
While minimizing external dependencies is essential, exceptions can be made case-by-case. There are situations where external dependencies are
3025
justified, such as when a well-established and actively maintained library provides significant benefits, like time savings, performance improvements,
3126
or specialized functionality unavailable in standard libraries.
3227

28+
## Change management
29+
30+
When you introduce a change in the code, specifically a deeply technical one, please ensure that the change provides same or improved set of capabilities.
31+
PRs that remove existing functionality shall be properly discussed and justified.
32+
3333
## Code Organization
3434

3535
When writing code, divide it into two main parts: **Components for API Interaction** and **Components for Business Logic**.

0 commit comments

Comments
 (0)