|
@@ -1,49 +1,48 @@
|
|
|
-# Warning we automaticly generate the following files
|
|
|
-# docs/README.md, template/portainer-v2-arm32.json, template/portainer-v2-arm64.json, tools/README.md, docs/AppList.md, docs/DocumentList.md, pi-hosted_template/template/portainer-v2.json
|
|
|
-# Please make any changes to these files instead
|
|
|
-# template/apps/*, build/templates/* build/info.json
|
|
|
-
|
|
|
-<!-- The title of the pull request should be a short description of what was done. -->
|
|
|
-
|
|
|
-<!-- You can remove any parts of this template not applicable to your Pull Request. -->
|
|
|
-
|
|
|
-# Summary
|
|
|
-
|
|
|
+## Warning we automatically generate the following files, your change(s) will overwritten.
|
|
|
+* docs/README.md
|
|
|
+* template/portainer-v2-arm32.json
|
|
|
+* template/portainer-v2-arm64.json
|
|
|
+* tools/README.md
|
|
|
+* docs/AppList.md
|
|
|
+* docs/DocumentList.md
|
|
|
+* pi-hosted_template/template/portainer-v2.json
|
|
|
+
|
|
|
+## Please make any changes to these files instead
|
|
|
+* template/apps/`some-application-name.json`
|
|
|
+* stack/`some-stack-name.yml`
|
|
|
+* docs/`some-docsname.md`
|
|
|
+* tools/`some-script.sh`
|
|
|
+* build/info.json
|
|
|
+
|
|
|
+<!-- Fill with - if not applicable-->
|
|
|
+## Summary
|
|
|
<!-- A short summary describing what was done... -->
|
|
|
|
|
|
-# Why This Is Needed
|
|
|
-
|
|
|
+### Why This Is Needed
|
|
|
<!-- Explain why this change is needed. Can be omitted if covered in the summary. -->
|
|
|
|
|
|
-# What Changed
|
|
|
-
|
|
|
+### What Changed
|
|
|
<!-- A detailed list of all the changes made, broken down by category. -->
|
|
|
|
|
|
-## Added
|
|
|
-
|
|
|
+### Added
|
|
|
<!-- What was added? -->
|
|
|
|
|
|
-## Changed
|
|
|
-
|
|
|
+### Changed
|
|
|
<!-- Did any functionality change? -->
|
|
|
|
|
|
-## Fixed
|
|
|
-
|
|
|
+### Fixed
|
|
|
<!-- Were any bugs fixed? -->
|
|
|
|
|
|
-## Removed
|
|
|
-
|
|
|
+### Removed
|
|
|
<!-- Was anything removed? -->
|
|
|
|
|
|
-# Screenshots
|
|
|
-
|
|
|
+### Screenshots
|
|
|
<!-- Please include screenshots of any new features to show how it works. -->
|
|
|
|
|
|
-# Checklist
|
|
|
-
|
|
|
+## Checklist
|
|
|
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
|
|
|
- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
|
|
|
- [ ] Does your submission pass tests?
|
|
|
- [ ] Have you linted your code locally prior to submission?
|
|
|
- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
|
|
|
-- [ ] Have you updated documentation, as applicable?
|
|
|
+- [ ] Have you updated documentation, as applicable?1
|