Skip to content

Commit 114e82b

Browse files
Merge pull request #83 from chuff/contributing
Added contributing guide
2 parents 6d0f8e2 + 77c6948 commit 114e82b

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contribution
2+
3+
In order to contribute to the improvement of the project, below you will find the project development flow.
4+
Before being able to open a PR with changes to be applied or bug fixes to be solved, it is necessary to open an issue
5+
and explain the reason and a possible solution. You can open each PR by forking the project and creating the PR directly from
6+
your project to the project of our library.
7+
8+
Main rules:
9+
- Open issue
10+
- Create PR from forked project
11+
- Link your PR to the issue
12+
13+
### Init
14+
15+
```sh
16+
npm install
17+
```
18+
19+
### Run tests
20+
21+
```sh
22+
npm run test
23+
```
24+
25+
### Build
26+
27+
```sh
28+
npm run build
29+
```
30+
31+
## ESM - CJS
32+
33+
This library is exported to support both ESM and CJS usage.
34+
To ensure a good output on ESM we need to add the extension on exports and imports with '.js'.
35+
This is necessary and also recommended by Typescript maintainers to
36+
generate code that works in environments where ESM can be used.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,3 +382,7 @@ __gpp("removeEventListener", callback?, parameter?)
382382
## Example Usage / Encoder / Decoder
383383

384384
[https://iabgpp.com](https://iabgpp.com)
385+
386+
## Contributing
387+
388+
Here you can find the [contributing guide](CONTRIBUTING.md) to help maintain and update the library. This library is managed by the Code Libraries Subgroup of the Global Privacy Working Group at the IAB Tech Lab. To join the group, please reach out to support@iabtechlab.com.

0 commit comments

Comments
 (0)