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: _mydocs/contribute/index.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Contribute to DAX Lib
4
4
menu_title: Contribute
5
5
published: true
6
6
date: 2025-08-14
7
-
modified: 2025-09-30
7
+
modified: 2025-10-15
8
8
order: /02
9
9
next_reading: true
10
10
---
@@ -15,9 +15,13 @@ Once the pull request is approved, the library is automatically packaged as a ZI
15
15
16
16
You can follow these steps to add a new package to DAX Lib:
17
17
18
-
1.**Fork** the GitHub repository [https://github.com/daxlib/daxlib/](https://github.com/daxlib/daxlib/fork).
18
+
1.**Fork** the DAX Lib repository [https://github.com/daxlib/daxlib/fork](https://github.com/daxlib/daxlib/fork).
19
+
20
+
This creates a personal copy of the repository in your GitHub account.
21
+
22
+
**Remarks**:
19
23
20
-
If you are using Visual Studio Code, you can open the workspace file `packages.code-workspace` to quickly access and work on the packages.
24
+
Do not make changes directly on the `main` branch. Always create a separate branch for each change you want to make. For example, `add-my-package-version-1.0.0`. This keeps your work isolated until it's reviewed and approved.
21
25
22
26
2.**Create a folder** for your package in `/packages/` and follow the [naming conventions](naming-conventions.md) for both the folder structure and name.
23
27
@@ -42,8 +46,8 @@ You can follow these steps to add a new package to DAX Lib:
42
46
4. **Create the DAX user-defined functions**in`lib/functions.tmdl` and follow the [naming conventions](naming-conventions.md) for the functionnames.
43
47
44
48
The file `lib/functions.tmdl` is a mandatory file and contains the source code of the DAX user-defined functions using the TMDL syntax. For an example, see the [DaxLib.Sample](https://daxlib.org/package/DaxLib.Sample/#code) package.
45
-
46
-
Remarks:
49
+
50
+
**Remarks**:
47
51
- The `functions.tmdl` file should contain only the functiondefinitions without the `createOrReplace` command.
48
52
- Optional: add comments describing the functionand its parameters to improve readability and usability, as suggested in the [DAX naming convention](https://docs.sqlbi.com/dax-style/dax-naming-conventions#comments).
49
53
- Each UDF must include the mandatory annotations: `DAXLIB_PackageId` and `DAXLIB_PackageVersion`.
@@ -59,7 +63,7 @@ You can follow these steps to add a new package to DAX Lib:
59
63
60
64
You can include a custom icon for your library by adding a PNG file inside the library's folder.
61
65
62
-
Remarks:
66
+
**Remarks**:
63
67
- The icon file must be in PNG format (`.PNG`), with a maximum size of 100 KB.
64
68
65
69
Example: for a library named `Contoso.Conversion` with version `1.0.0`, place the icon file at:
@@ -80,8 +84,8 @@ You can follow these steps to add a new package to DAX Lib:
80
84
6. **(Optional) Add a README file**
81
85
82
86
You can include a README file to provide documentation for your library. It can include general information about the library, usage instructions, examples, and any notes for users.
83
-
84
-
Remarks:
87
+
88
+
**Remarks**:
85
89
- The file must be in Markdown format (`.MD`), with a maximum size of 100 KB.
86
90
- For security reasons, only a limited set of Markdown features are supported, and external links may be restricted to trusted domains.
87
91
@@ -102,6 +106,6 @@ You can follow these steps to add a new package to DAX Lib:
102
106
103
107
7. **Create a pull request** to publish the library on [daxlib.org](https://daxlib.org/)
104
108
105
-
a. The pull request must be approved manually by DaxLib owners/maintainers.
106
-
107
-
b. When the pull request is approved, the package is immediately published.
109
+
- Go [here](https://github.com/daxlib/daxlib/pull/new) to create a new pull request from your forked repository to the official DAX Lib repository.
110
+
- The pull request must be approved manually by DaxLib owners/maintainers.
111
+
- When the pull request is approved, the package is immediately published.
0 commit comments