Relicence to dual-licenced AGPL-3.0-only + commercial with CLA

    Adds a github actions workflow which manages CLA signing/checking

    Co-authored-by: Paul Richmond <[email protected]>

Author: ptheywood

.github/workflows/cla.yml

@@ -0,0 +1,55 @@
+name: "CLA Assistant"
+
+# The CLA assistant workflow must have write scope for pull request comments, and so must be ran on pull_request_target, and issue comments.
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+# Explicit permissions
+permissions:
+  actions: write
+  contents: read
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    # Only run the job at all for pull_request_targets or comments which contain one of two strings.
+    # Contains is used to allow whitespace in the comment which is checked in an inner step.
+    if: github.event_name == 'pull_request_target' || (contains(github.event.comment.body, 'recheck') || contains(github.event.comment.body, 'I have read the CLA Document and I hereby sign the CLA'))
+    runs-on: ubuntu-latest
+    steps:
+      # If triggered by an issue comment, compare a trimmed version to allow for additional whitespace.
+      # Uses JS to avoid having to do shell character escaping nicely
+      - name: "Check comment"
+        id: check_trimmed_comment
+        if: github.event_name == 'issue_comment'
+        uses: actions/github-script@v8
+        with:
+          script: |
+            const comment = context.payload.comment.body;
+            const trimmed = comment.trim();
+            if (trimmed === 'recheck' || trimmed === 'I have read the CLA Document and I hereby sign the CLA') {
+              return 'true';
+            } else {
+              return 'false';
+            }
+          result-encoding: string
+
+      # For pull_request_triggers, or comments which contained (whitespace wrapped) trigger phrases, run the contributor assistant
+      - name: "Contributor Assistant"
+        if: github.event_name == 'pull_request_target' || steps.check_trimmed_comment.outputs.result == 'true'
+        uses: FLAMEGPU/contributor-assistant-github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_SIGNATURES_PAT }}
+        with:
+          path-to-signatures: 'signatures/v1/cla.json'
+          path-to-document: 'https://flamegpu.com/cla/'
+          branch: 'main'
+          # allowlist: bot*
+          remote-organization-name: FLAMEGPU
+          remote-repository-name: cla-signatures
+          lock-pullrequest-aftermerge: false

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to FLAME GPU 2
+
+Looking to contribute to FLAME GPU 2? **Here's how you can help.**
+
+Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+## Reporting Bugs
+
+1. Use the GitHub issue search -- check if the issue has already been reported.
+2. Check if the issue has been fixed -- try to reproduce it with the latest `master` or development branch.
+3. Isolate the problem -- ideally create a [minimal example](https://stackoverflow.com/help/minimal-reproducible-example).
+4. Complete the [bug report template](https://github.com/FLAMEGPU/FLAMEGPU2-visualiser/issues/new) -- provide as much relevant detail as possible.
+
+A good bug report should contain all the information necessary to allow a developer to reproduce the issue, without needing to ask for further information.
+Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What CUDA version, GPU and OS experience the problem? What is the expected outcome?
+All of these details assist the process of investigating and fixing bugs.
+
+## Requesting Features
+
+Feature requests are welcome, FLAME GPU 2 is under active development and as a general agent-based modelling framework aims to provide all functionality required by modellers. However, it's up to *you* to make a strong case to convince the project's developers of the merits and priority of this feature. Please provide as much detail and context as possible.
+
+Complete the [feature request template](https://github.com/FLAMEGPU/FLAMEGPU2-visualiser/issues/new).
+
+## Submitting Pull Requests
+
+Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+Please adhere to the [coding conventions](#Coding-Conventions) used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
+
+Before merging pull requests are required to pass all continuous integration:
+
+* The full codebase should build with the `FLAMEGPU_WARNINGS_AS_ERRORS` option enabled under the provided CMake configuration, on both Windows and Linux.
+* The full test suite should pass.
+* `cpplint` should report no issues, using `CPPLINT.cfg` found in the root of the project.
+
+Ideally, these should be addressed as far as possible before creating a pull request. Executing linter are detailed in the main [README](README.md).
+
+### Coding Conventions
+
+A consist code style throughout
+
+The code within FLAME GPU conforms to the [Google C++ style guide](https://google.github.io/styleguide/cppguide.html), as enforced by `cpplint`, with a number of relaxations:
+
+* `[Formatting/Line Length]`: Relaxed to a limit of 240 characters.
+
+<!--### Naming Conventions
+??????
+--->
+
+#### Checking Code Style
+
+As detailed within the main [README](README.md), if `cpplint` is installed CMake will generate lint targets which report code which strays from the projects coding style.
+
+This can be executed using `make lint_all` or building the `lint_all` project.
+
+*Note: If adding new files, they will first need to be added to `CMakeLists.txt` and CMake configure re-ran.*
+
+### Updating CMakeLists.txt
+
+If adding new source or header files, it is necessary to add them to the list of files within the relevant `CMakeLists.txt`:
+
+The main FLAME GPU 2 visualiser library: within [`src`](tree/master/src).
+
+Changes may also need to be made to the main [FLAME GPU 2 library](https://github.com/FLAMEGPU/FLAMEGPU2), if the interface is changed.
+
+This ensure that users on both Linux and Windows can continue to build FLAME GPU 2.
+
+## License
+
+FLAME GPU is available under two licenses:
+
+- [AGPL-3.0-only license](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/LICENSE.md) for open source usage
+- A commercial licenses for cases where the use of the open source AGPL-licensed version is not possible or desirable. Please see [flamegpu.com/license/download/](https://flamegpu.com/download/license/) for more information.
+
+### Contributor License Agreement (CLA)
+
+Before we can accept your pull request, you need to sign our [CLA](https://flamegpu.com/cla/) so that we can redistribute any changes via our dual license model.
+Our CLA assistant should check and prompt you to sign the CLA when you create your pull request.