Release Prep

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] "
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1.
+2.
+3.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment**
+
+- Node.js version:
+- acorn.js version:
+- OS:
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] "
+labels: enhancement
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,26 @@
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Related Issue
+
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist
+
+<!--- Go over all the following points, and put an `x` in all boxes that apply. -->
+
+- [ ] My code follows the code style of this project
+- [ ] My change requires a documentation update
+- [ ] I have updated the documentation accordingly
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed

.github/workflows/maven.yml

@@ -26,6 +26,8 @@ jobs:
         ./mvnw -B org.apache.maven.plugins:maven-dependency-plugin:3.8.1:go-offline de.qaware.maven:go-offline-maven-plugin:1.2.8:resolve-dependencies
 
     - name: Build with Maven
+      env:
+        SPRING_AI_OPENAI_API_KEY: ${{ secrets.SPRING_AI_OPENAI_API_KEY }}
       run: ./mvnw -B test -Pci
 
     - name: Import GPG Key

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+## Contributing to Acorn
+
+Thanks for your interest in DataSQRL's Acorn.
+
+# Contributions
+
+We welcome contributions from anyone.
+
+Submit a pull request and it will be reviewed by a contributor or committer in the project. The
+contributor may ask for changes or information before being accepted.
+
+## Committers
+
+Committers for this project can be viewed on the Github project page.
+
+# Sign Your Work
+
+The _sign-off_ is a simple line at the end of the message for a commit. All commits need to be signed.
+Your signature certifies that you wrote the patch or otherwise have the right to contribute the material
+(see [Developer Certificate of Origin](https://developercertificate.org)):
+
+```
+This is my commit message
+
+Signed-off-by: John Doe <[email protected]>
+```
+
+Git has a [`-s`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) command line option to
+append this automatically to your commit message:
+
+```bash
+$ git commit -s -m "This is my commit message"
+```
+
+Unfortunately, anyone with write access to a repository can easily impersonate another user.
+Consider how each commit is associated with a user via their email address.
+There's nothing stopping someone from using someone else's email address to make commits.
+The issue extends to the signoff message as well.
+
+That's why it's advisable to sign your commits with a unique key. Git offers support for various types of keys,
+and this time, we'll walk you through signing your commits using GPG.
+
+#### Setup Git using GPG
+
+Ensure that gpg is installed on your system.
+
+On MacOS:
+
+```bash
+brew install gpg
+```
+
+Generate your key:
+
+```bash
+gpg --full-generate-key
+```
+
+Recommended settings:
+
+- **key kind:** (1) RSA and RSA
+- **key size:** 4096
+- **key validity:** key does not expire
+  (you can revoke keys, so unless you don't lose access to your key it is more convenient)
+- **real name:** it is recommended using your real name
+- **email address:** it is recommended to use the same email address here that you use to commit your work
+- **comment:** it is recommended to use different keys for different use-cases / organizations.
+  If you use the same email across organizations, you can distinguish your keys with the help of this field.
+  eg.: "CODE SIGNING KEY" or "ACORN CODE SIGNING KEY"
+
+You can create the new key by selecting "(O)kay"
+
+To view your key, you issue this command:
+
+```bash
+gpg --list-secret-keys --keyid-format=long
+```
+
+The output should look like this:
+
+```
+sec   rsa4096/D2A162EAE1016F3G 2024-04-05 [SC]
+      AFB8C2DEFEA93470D81C84E7D2A162EAE1016F3G
+uid                 [ultimate] John Doe (CODE SIGNING KEY) <[email protected]>
+ssb   rsa4096/2F7B9EAC4D6F8150 2024-04-05 [E]
+```
+
+To use the above key to sign your commits cd into a repository and issue these commands:
+
+```bash
+git config user.signingkey D2A162EAE1016F3G
+git config commit.gpgsign true
+```
+
+You also need to add the public key to your github profile for the signing to be verified.
+
+To do so, go to your github settings page, select the `SSH and GPG keys` tab.
+
+Press `New GPG Key`, then enter a name for the key and the outputs of the following command.
+
+```
+gpg --armor --export D2A162EAE1016F3G
+```
+
+## License
+
+By contributing to Acorn, you agree that your contributions will be licensed under the Apache License 2.0.