Skip to content

Commit 81f0f33

Browse files
author
Chad Huff
committed
added contributing guide
1 parent daffbe9 commit 81f0f33

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
### Run tests
14+
15+
```sh
16+
mvn clean test
17+
```
18+
19+
### Build
20+
21+
```sh
22+
mvn clean install
23+
```

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,3 +260,6 @@ CmpList cmpList = loader.cmpList(cmpListContent);
260260
|usct|12|GpcSegmentIncluded|Boolean. Default value is true|
261261
|usct|12|Gpc|Boolean|
262262

263+
## Contributing
264+
265+
Here you can find the [contributing guide](CONTRIBUTING.md) to help maintain and update the library.

0 commit comments

Comments
 (0)