Skip to content

Commit 5fe5b66

Browse files
committed
Clarified fork workflow in contribute/index
1 parent 2481425 commit 5fe5b66

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

_mydocs/contribute/index.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Contribute to DAX Lib
44
menu_title: Contribute
55
published: true
66
date: 2025-08-14
7-
modified: 2025-09-30
7+
modified: 2025-10-15
88
order: /02
99
next_reading: true
1010
---
@@ -15,9 +15,13 @@ Once the pull request is approved, the library is automatically packaged as a ZI
1515

1616
You can follow these steps to add a new package to DAX Lib:
1717

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**:
1923

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.
2125

2226
2. **Create a folder** for your package in `/packages/` and follow the [naming conventions](naming-conventions.md) for both the folder structure and name.
2327

@@ -42,8 +46,8 @@ You can follow these steps to add a new package to DAX Lib:
4246
4. **Create the DAX user-defined functions** in `lib/functions.tmdl` and follow the [naming conventions](naming-conventions.md) for the function names.
4347

4448
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**:
4751
- The `functions.tmdl` file should contain only the function definitions without the `createOrReplace` command.
4852
- Optional: add comments describing the function and its parameters to improve readability and usability, as suggested in the [DAX naming convention](https://docs.sqlbi.com/dax-style/dax-naming-conventions#comments).
4953
- 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:
5963

6064
You can include a custom icon for your library by adding a PNG file inside the library's folder.
6165
62-
Remarks:
66+
**Remarks**:
6367
- The icon file must be in PNG format (`.PNG`), with a maximum size of 100 KB.
6468
6569
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:
8084
6. **(Optional) Add a README file**
8185
8286
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**:
8589
- The file must be in Markdown format (`.MD`), with a maximum size of 100 KB.
8690
- For security reasons, only a limited set of Markdown features are supported, and external links may be restricted to trusted domains.
8791
@@ -102,6 +106,6 @@ You can follow these steps to add a new package to DAX Lib:
102106
103107
7. **Create a pull request** to publish the library on [daxlib.org](https://daxlib.org/)
104108
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

Comments
 (0)