Merge pull request #3 from TrustlyInc/DEV-224374-add-basic-contributi…

…ng-guide-to-example-apps

[DEV-224374] Add basic contributing guide to example apps

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+### Description
+
+_(Insert pull request description)_
+
+---
+
+### Relevant Commits
+
+_(List of main updates)_
+
+---
+
+### Requirements
+
+_(Please check if your pull request fulfills the following requirements)_
+
+- [ ] Changes were properly tested (attach evidence if applicable)
+- [ ] Repository's code-style/linting compliant
+
+---
+
+### Evidence
+
+_(Insert any evidence related to this pull request. Leave it as **"None"** or **"Not applicable"** if you have nothing to add)_
+
+---
+
+### Additional Information
+
+_(Insert any additional information related to this pull request, as more context or Jira ticket. Leave it as **"None"** or **"Not applicable"** if you have nothing to add)_

README.md

@@ -7,31 +7,44 @@
 ```
 git clone [email protected]:TrustlyInc/trustly-cordova-example.git
 ```
+
 2. Install project dependencies
 
 ```
 npm install
 ```
 
 3. Add desired platforms to your project. We suggest at least adding `ios` and `android`.
+
 ```
 npx cordova platform add ios && npx cordova platform add android
 ```
 
 4. Replace the placeholder tokens with your credentials:
+
 ```
 // ./www/js/index.js
 
 const ACCESS_ID = 'YOUR_ACCESS_ID';
 const MERCHANT_ID = 'YOUR_MERCHANT_ID';
 ```
+
 Also replace YOUR_ACCESS_ID in `./www/index.html` within the script tag that loads `trustly.js`.
 
 5. Start the app!
+
 ```
 npx cordova run ios
 ```
+
 or
+
 ```
 npx cordova run android
-```
+```
+
+# Contributing
+
+You can participate in this project by submitting bugs and feature requests in the [Issues](https://github.com/TrustlyInc/trustly-cordova-example/issues) tab. Please, add [@lukevance](https://github.com/lukevance) as an assignee.
+
+If you are interested in fixing issues and contributing directly to the code base, feel free to open a Pull Request with your changes. Please, make sure to fulfill our [Pull Request Template](https://github.com/TrustlyInc/trustly-cordova-example/blob/main/.github/pull_request_template.md) and add [@lukevance](https://github.com/lukevance) as code reviewer.