diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b2ce988 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 + +[*.{yml,yaml}] +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false + +[*.xml] +indent_size = 4 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8c6918b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: New example request +description: Propose a student-friendly example or learning exercise using the published Cortex4J API +title: "[Example]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: "Suggest examples that can be built using the public Maven dependency. Do not include credentials, private device identifiers, or unpublished library source." + - type: input + id: goal + attributes: + label: Learning goal + description: What should a student learn from this example? + placeholder: "e.g., subscribe to an EEG data stream and print selected values" + validations: + required: true + - type: textarea + id: behavior + attributes: + label: Proposed example + description: Describe the expected behavior, input, and output. + validations: + required: true + - type: textarea + id: prerequisites + attributes: + label: Prerequisites + description: Device, account, software, permissions, or simulator requirements. Never share secrets. + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: How could a student verify it works? + description: Provide observable success criteria and possible failure cases. + validations: + required: true + - type: textarea + id: notes + attributes: + label: Additional context + description: Optional links, references, or limitations. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..dc11841 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,24 @@ +version: 2 +updates: + - package-ecosystem: "maven" + directory: "/" + schedule: + interval: "weekly" + open-pull-requests-limit: 3 + ignore: + # Keep student examples pinned to the intentionally documented release. + - dependency-name: "com.javiergs:cortex4j" + groups: + maven-maintenance: + patterns: + - "*" + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + open-pull-requests-limit: 3 + groups: + github-actions: + patterns: + - "*" diff --git a/.gitignore b/.gitignore index 1cff8fe..b55abee 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,9 @@ target/ .vscode/ src/main/resources/cortex4j.properties .env +# Operating system files +.DS_Store +Thumbs.db + +# Local logs +*.log