Skip to content

Commit 2d12dae

Browse files
committed
Improve contribution guidelines
1 parent a4fdf97 commit 2d12dae

5 files changed

Lines changed: 21 additions & 20 deletions

File tree

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: Contribute to DAX Lib open-source libraries
3+
title: Contribute to DAX Lib official libraries
44
menu_title: DAX Lib libraries
55
published: true
66
date: 2025-10-17
@@ -9,8 +9,10 @@ order: /05
99
next_reading: true
1010
---
1111

12-
**TO BE COMPLETED**
13-
To contribute to one of the DaxLib open-source libraries maintained by the DaxLib organization, follow these steps:
14-
1. Fork one of the dev-daxlib repos based corresponding to the library name.
15-
2. Apply the change, commit, and submit a Pull Request.
16-
3. Wait for review and approval.
12+
> This section is a work in progress and will be completed soon.
13+
14+
To contribute to one of the official libraries maintained by the DAX Lib organization, follow these steps:
15+
16+
1. Fork the repository for the library you want to contribute to. You can find all `dev-daxlib-*` repositories on [DAX Lib's GitHub page](https://github.com/orgs/daxlib/repositories).
17+
2. Make your changes, commit them, and submit a Pull Request.
18+
3. Wait for your contribution to be reviewed and approved.

_mydocs/contribute/fork-daxlib.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,7 @@ order: /03
99
next_reading: true
1010
---
1111

12-
A DAX library is a collection of DAX user-defined functions (UDFs) authored in TMDL format, along with metadata (such as library name, version, author, etc.) and optional files like a README or an icon.
13-
Development takes place in the [DaxLib GitHub repository](https://github.com/daxlib/daxlib/), where users can propose new libraries by submitting a pull request (PR).
14-
Once the pull request is approved, the library is automatically packaged as a ZIP file and published on [daxlib.org](https://daxlib.org/), making it available for browsing, installation, and use.
15-
16-
You can follow these steps to add a new package to DAX Lib:
12+
For small libraries (a few functions), you can follow these steps to add a new package to DAX Lib:
1713

1814
1. **Fork** the DAX Lib repository [https://github.com/daxlib/daxlib/fork](https://github.com/daxlib/daxlib/fork).
1915

@@ -107,5 +103,5 @@ You can follow these steps to add a new package to DAX Lib:
107103
7. **Create a pull request** to publish the library on [daxlib.org](https://daxlib.org/)
108104
109105
- 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.
106+
- The pull request must be approved manually by DAX Lib owners/maintainers.
111107
- When the pull request is approved, the package is immediately published.

_mydocs/contribute/github-repo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ order: /04
99
next_reading: true
1010
---
1111

12+
> This section is a work in progress and will be completed soon.
13+
1214
You don’t have to create a repository for your DAX library on daxlib.org, but it’s a smart move if you expect the library to grow. A GitHub repo helps you track issues, accept contributions, and manage changes easily.
1315

1416
To create a GitHub repository for your DAX library, ensure you have a GitHub account; if not, create one. Then, follow the instructions at [https://github.com/daxlib/lib-quickstart-template](https://github.com/daxlib/lib-quickstart-template)
1517

16-
**TODO**
17-
1818
You can follow these steps to add a new package to DAX Lib:
1919

2020
1. **Create a name** for your package following the [naming conventions](naming-conventions.md) for both the name of the library and the package.

_mydocs/contribute/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ title: Contribute to DAX Lib
44
menu_title: Contribute
55
published: true
66
date: 2025-08-14
7-
modified: 2025-10-15
7+
modified: 2025-10-17
88
order: /02
99
next_reading: true
1010
---
1111

12-
Depending on the size and complexity of your DAX library, you can choose one of the following methods to contribute it to DAX Lib:
12+
A DAX library is a collection of DAX user-defined functions (UDFs) written in TMDL format, along with metadata such as the library name, version, and author. It can also include optional files like a README or an icon. Users can contribute by submitting a pull request (PR). Once approved, the library is automatically packaged as a ZIP file and published on daxlib.org, making it available for browsing, installation, and use.
13+
14+
Depending on your DAX library's size and complexity, you can choose one of the following methods to contribute it to DAX Lib:
15+
1316
1. For small libraries (a few functions), follow the [Contribute Small Libraries to DAX Lib](fork-daxlib.md) guide.
1417
2. For medium to large libraries (more functions, more complex logic), consider creating a dedicated GitHub repository by following the [Contribute Medium-Large Libraries to DAX Lib](github-repo.md) guide.
15-
3. If you want to contribute to one DaxLib prefixed library that is maintained by the DaxLib organization, follow the [Contribute to DAX Lib open-source libraries](daxlib-libraries.md) guide.
18+
3. If you want to contribute to one DAX Lib official library that is maintained by the DAX Lib organization, follow the [Contribute to DAX Lib official libraries](daxlib-libraries.md) guide.

_mydocs/contribute/naming-conventions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ When creating a new package for DAX Lib, it is important to follow specific conv
2121

2222
2. **Package Folder Name** (⚠️ only for Small Libraries)
2323

24-
> This naming convention must be manually managed if you create a Small Library by forking the DAX Lib repository.
25-
24+
> This naming convention only applies to Small Libraries created by forking the DAX Lib repository.
25+
2626
- The folder name for your package should be in lowercase letters and use dots to separate different levels of hierarchy.
2727

2828
Example: for a package named `Contoso.Conversion`, the folder name should be:
@@ -69,7 +69,7 @@ When creating a new package for DAX Lib, it is important to follow specific conv
6969
- Do not use `DaxLib.` as a prefix for package name. This prefix is reserved for public open-source libraries of common use. Do not submit pull requests for new libraries using the `DaxLib.` prefix.
7070

7171
6. **Folder Structure** (⚠️ only for Small Libraries)
72-
> This naming convention must be manually managed if you create a Small Library by forking the DAX Lib repository.
72+
> This naming convention only applies to Small Libraries created by forking the DAX Lib repository.
7373
- The **first level** structure should be a single letter (lowercase) corresponding to the first letter of the package name. This helps reduce the number of items in a single folder and keeps the repository organized.
7474
- The **second level** should be the package name (lowercase).
7575
- The **third level** should be the package version.

0 commit comments

Comments
 (0)