Merge pull request #88 from maykinmedia/feature/community-update

Prepped repo for community release

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,40 @@
+name: Probleem melden / Bug report
+description: Meldt een probleem om ons te helpen verbeteren  / Create a report to help us improve
+title: "Title here"
+labels: ["bug", "triage"]
+assignees: []
+body:
+  - type: input
+    id: product-version
+    attributes:
+      label: Product versie / Product version
+      description: Welke versie gebruikt u? / Which version do you use?
+      placeholder: "1.1.0"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Omschrijf het probleem / Describe the bug
+      description: Een duidelijke omschrijving van het probleem (de "bug") / A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Stappen om te reproduceren / Steps to reproduce
+      description: Stappen die leiden tot het probleem / Steps to reproduce the behavior
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: false
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Verwacht gedrag / Expected behavior
+      description: Een duidelijke omschrijving van wat de verwachting is / A clear and concise description of what you expected to happen.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  # - name: Meldt een veiligheidsprobleem / Report a security vulnerability
+  #   url: https://github.com/maykinmedia/open-klant/security/policy
+  #   about: Bekijk ons beveiligingsbeleid voor meer informatie / Please review our security policy for more details
+  - name: Ondersteuning met prioriteit / Priority support
+    url: https://opengem.nl/contact/
+    about: Neem direct contact met ons op / Contact us directly to get priority support.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,27 @@
+name: Verzoek tot verbetering / Feature request
+description: Stel een idee voor om het project beter te maken / Suggest an idea for this project
+title: "Title here"
+labels: ["enhancement", "triage"]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Omschrijving / Description
+      description: Omschrijf duidelijk het idee of de behoefte, eventueel aangevuld met een bepaalde oplossingsrichting / Clearly describe the idea or need, possibly supplemented with a specific solution direction
+    validations:
+      required: true
+  - type: textarea
+    id: added-value
+    attributes:
+      label: Added value / Toegevoegde waarde
+      description: Omschrijf de toegevoegde waarde voor de bedrijfsvoering of dienstverlening / Describe the added value for business operations or services
+    validations:
+      required: false
+  - type: textarea
+    id: remarks
+    attributes:
+      label: Aanvullende opmerkingen / Additional context
+      description: Voeg aanvullingen of mockups toe voor deze verbetering / Add any other context or screenshots about the feature request
+    validations:
+      required: false

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: 'ubuntu-20.04'
+  apt_packages:
+    - libxml2-dev
+    - libxmlsec1-dev
+    - libxmlsec1-openssl
+    - wget
+  tools:
+    python: '3.10'
+
+python:
+  install:
+    - requirements: requirements/ci.txt

AUTHORS

@@ -0,0 +1,26 @@
+The Open Klant project was initiated by Municipality of The Hague to store
+a minimal set of data and metadata about clients and conversations with 
+clients, in compliance with privacy and security regulations.
+
+Open Klant is a registration component to re-use client data within the whole 
+municipality, following with the Common Ground principles.
+
+Here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
+people who laid the groundwork, have submitted patches, reported bugs, added
+translations, helped answer questions, and generally made Open Forms that much 
+better:
+
+    Steven Bal
+    Alex de Landgraaf
+    Nathanael Gey
+    Bart van der Schoor
+    ErhanCitil
+    Joeri Bekker
+    Bart Burgmans
+
+A big THANK YOU goes to:
+
+    All municipalities who participated and risked implementing an API 
+    specification that was not yet finalized by VNG.
+
+    All people behind Common Ground for their enthusiasm and vision.

CHANGELOG.rst

@@ -2,10 +2,46 @@
 Change history
 ==============
 
+0.6.0
+=====
+
+*tbd*
+
+
+*VNG officially retired the Klanten and Contactmomenten API, which never had an
+official release. These API's are replaced by the Klantinteractie API. In 
+cooperation with several municipalities and VNG, Open Klant will implement the 
+new API specification and might introduce backwards incompatible changes. Since
+Open Klant never had an official 1.0 release, we will continue versioning on 
+the 0.x.x-scheme.*
+
+0.5.0-pre
+=========
+
+*August 5, 2023*
+
+* [#51] Showing version & git hash on the home page
+
+0.3.0-pre
+=========
+
+*July 24, 2023*
+
+* [#50] Added Notificatie API support
+
+0.2.0-pre
+=========
+
+*June 14, 2023*
+
+* [#46] Fixed CI code-quality issues
+* [#45] Updated docs and URLs to use new Github location
+* [#44] Updated project dependencies
+* [#48] Add missing auth to URLValidator for klantcontactmoment
 
 0.1.0
-=====
+=========
 
-*<month, day year>*
+*February 13, 2023*
 
 * Initial release.

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `helpdesk@maykinmedia.nl`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contribution guidelines
+
+If you want to contribute, we ask you to follow these guidelines.
+
+## Reporting bugs
+
+If you have encountered a bug in this project, please check if an issue already 
+exists in the list of existing [issues][issues]. If such an issue does not 
+exist, you can create a [new issue][new_issue]. When writing the bug report, 
+try to add a clear example that shows how to reproduce said bug.
+
+## Adding new features
+
+Before making making changes to the code, we advise you to first check the list 
+of existing [issues][issues] for this project to see if an issue for the 
+suggested changes already exists. If such an issue does not exist, you can 
+create a [new issue][new_issue]. Creating an issue gives an opportunity for 
+other developers to give tips even before you start coding.
+
+### Code style
+
+To keep the code clean and readable, this project uses:
+
+- [`isort`](https://github.com/timothycrosley/isort) to order the imports
+- [`black`](https://github.com/psf/black) to format the code and keep diffs for 
+  pull requests small
+- [`flake8`](https://github.com/PyCQA/flake8) to clean up code (removing unused
+  imports, etc.)
+
+Whenever a branch is pushed or a pull request is made, the code will be checked 
+in CI by the tools mentioned above, so make sure to install these tools and run 
+them locally before pushing branches/making pull requests.
+
+This project aims to meet the criteria of the 
+[Standard for Public Code][Standard_for_Public_Code]. Please make sure that 
+your pull requests are compliant, that will make the reviews quicker.
+
+### Forking the repository
+
+In order to implement changes to this project when you do not have rights for 
+this [repository][repository], you must first fork the repository. Once the 
+repository is forked, you can clone it to your local machine.
+
+### Making the changes
+
+On your local machine, create a new branch, and name it like:
+- `feature/some-new-feature`, if the changes implement a new feature
+- `issue/some-issue`, if the changes fix an issue
+
+Once you have made changes or additions to the code, you can commit them (try 
+to keep the commit message descriptive but short). If an issue already exists 
+in the list of existing [issues][issues] for the changes you made, be sure to 
+format your commit message like 
+`:gitmoji: Fixes #<issue_id> -- description of changes made`, where 
+`<issue_id>` corresponds to the number of the issue on GitHub. To demonstrate 
+that the changes implement the new feature/fix the issue, make sure to also add 
+tests to the existing Django testsuite.
+
+#### Refactoring
+
+You can refactor existing code as part of any issue. For example when fixing a
+bug or extending an existing feature. The refactored code should be about the
+issue though. Please document in the commit why you refactored the code.
+The part of the refactored code should typically be a separate commit before
+the commit that tackles the actual issue, so they can be reviewed separately.
+
+#### Small textual changes
+
+For small textual changes like fixing incorrect spelling, hyperlinks, outdated
+information, code documentation, etc. you don't need to create an issue. Simply
+create a Pull Request (see below) that does the update.
+
+### Making a pull request
+
+If all changes have been committed, you can push the branch to your fork of the 
+repository and create a pull request to the `master` branch of this project's 
+repository. Your pull request will be reviewed, if applicable, feedback will be 
+given and if everything is approved, it will be merged.
+
+Pull requests should always be made to the `master` branch, even if they are 
+bugfixes for any of the `stable/*` branches. If they are relevant for older 
+versions, please add the *needs-backport* label to the pull request and/or 
+issue. Release managers will then ensure the fix also lands in the supported 
+older versions.
+
+### Reviews on releases
+
+Open Klant community support is provided by [Maykin][Maykin]. 
+The community support team is responsible for reviewing all pull requests 
+before they are merged to a release branch.
+
+
+[issues]: https://github.com/maykinmedia/open-klant/issues
+[new_issue]: https://github.com/maykinmedia/open-klant/issues/new/choose
+[mailinglist]: t.b.d.
+[Standard_for_Public_Code]: https://standard.publiccode.net
+[repository]: https://github.com/maykinmedia/open-klant
+[Maykin]: https://www.maykinmedia.nl

INSTALL.rst

@@ -18,9 +18,9 @@ Prerequisites
 
 You need the following libraries and/or programs:
 
-* `Python`_ 3.6 or above
+* `Python`_ 3.11 or above
 * Python `Virtualenv`_ and `Pip`_
-* `PostgreSQL`_ 10 or above
+* `PostgreSQL`_ 11 or above
 * `Node.js`_
 * `npm`_
 
@@ -47,10 +47,7 @@ development machine.
        $ git clone git@github.com:maykinmedia/open-klant.git
        $ cd open-klant
 
-3. Install all required (backend) libraries.
-   **Tip:** You can use the ``bootstrap.py`` script to install the requiments
-   and set the proper settings in ``manage.py``. Or, perform the steps
-   manually:
+3. Install all required (backend) libraries:
 
    .. code-block:: bash