Contributions guidelines

Author: thomasleplus

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable-next-line MD041 -->
+## Readiness checklist
+<!-- prettier-ignore-end -->
+
+Please check the boxes below to confirm that you have followed the
+required guidelines for contributions:
+
+- [ ] If this pull request includes code changes, they were all properly tested. Automated tests where also included where possible.
+- [ ] This pull request includes the relevant documentation for this change (if applicable).
+- [ ] All the commits in this pull request where squashed into a single commit. That commit is [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification).
+- [ ] If this pull request is about and existing issue, I added the `Fix #ISSUE_NUMBER` or `Close #ISSUE_NUMBER` text to the description of the pull request.

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+## Creating an issue
+
+If you have found a bug, want to request an enhancement or simply ask
+a question, feel free to open an
+[issue](https://github.com/leplusorg/docker-csv/issues/new/choose).
+
+For security-related issues, please see our [security policy](/SECURITY.md).
+
+## Submitting a pull request
+
+If you want to contribute code, documentation etc. you can open a pull
+request. We then kindly ask that:
+
+- before working or submitting a large pull request, please open an
+  issue to discuss what you have in mind and check that there is not
+  an existing solution or a different approach.
+- all code changes must be tested manually and automated tests should
+  be included when possible.
+- all necessary documentation should be included as well.
+- commits on a single pull request must be squashed together to keep
+  make reviews easier.
+- commits must be signed (this is supported by most Git clients as
+  well as the GitHub web UI, see link below).
+
+## Resources
+
+- [Managing commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification)
+- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)

README.md

@@ -2,7 +2,7 @@
 
 Docker container to run CSV manipulation utitilies (csvkit...).
 
-[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](https://github.com/leplusorg/docker-csv/blob/main/csv/Dockerfile)
+[![Dockerfile](csv/Dockerfile)
 [![Docker Build](https://github.com/leplusorg/docker-csv/workflows/Docker/badge.svg)](https://github.com/leplusorg/docker-csv/actions?query=workflow:"Docker")
 [![Docker Stars](https://img.shields.io/docker/stars/leplusorg/csv)](https://hub.docker.com/r/leplusorg/csv)
 [![Docker Pulls](https://img.shields.io/docker/pulls/leplusorg/csv)](https://hub.docker.com/r/leplusorg/csv)