-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also updated the README.md with how to contribute and changed the Contact part to be less dependent on individuals
- Loading branch information
Showing
2 changed files
with
44 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Contributing | ||
This project is open to accept feature requests and contributions from the open source community. | ||
Please fork the repo and start a new branch to work on. | ||
|
||
|
||
## Building locally | ||
This project is using [Gradle](https://gradle.org/) for its build tool. | ||
A Gradle Wrapper is included in the code though so you do not have to manage your own installation. | ||
|
||
To run a build simply exucute the following: | ||
|
||
```shell script | ||
./gradlew shadowJar | ||
``` | ||
|
||
This will run all the steps defined in the `build.gradle.kts` file. | ||
|
||
|
||
## Testing | ||
If you are adding a new feature or bug fix please ensure there is proper test coverage. | ||
|
||
## Pull Request Review | ||
If you have a branch on your fork that is ready to be merged, please create a new pull request. The maintainers will review to make sure the above guidelines have been followed and if the changes are helpful to all library users, they will be merged. | ||
|
||
This project uses [semantic versioning](https://semver.org/) and does NOT prefix tags or release titles with `v` i.e. use `1.2.3` instead of `v1.2.3` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,10 +58,22 @@ making this ideal for developing new templates for your application. | |
|
||
The template and data directory structure both follow the `<application>/<template>` structure. | ||
|
||
## Contact us | ||
### Code/project related questions can be sent to | ||
* Kent Daleng, `[email protected]` | ||
* Kevin Sillerud, `[email protected]` | ||
|
||
### For NAV employees | ||
We are also available on the slack channel #pdfgen for internal communication. | ||
## 👥 Contact | ||
|
||
This project is currently maintained by the organisation [@navikt](https://github.com/navikt). | ||
|
||
If you need to raise an issue or question about this library, please create an issue here and tag it with the appropriate label. | ||
|
||
For contact requests within the [@navikt](https://github.com/navikt) org, you can use the slack channel #pdfgen | ||
|
||
If you need to contact anyone directly, please see contributors. | ||
|
||
## ✏️ Contributing | ||
|
||
To get started, please fork the repo and checkout a new branch. You can then build the library with the Gradle wrapper | ||
|
||
```shell script | ||
./gradlew shadowJar | ||
``` | ||
|
||
See more info in [CONTRIBUTING.md](CONTRIBUTING.md) |