From 66d2e9be2c63f55ee6b101f30cc5cfc1864db065 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:17 -0700 Subject: [PATCH 1/8] docs: relocate CONTRIBUTING.md to .github --- .github/CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d36f712 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to Cortex4J Getting Started + +Thank you for improving the public CORTEX4J learning materials. This repository contains examples and documentation for the published Cortex4J library; the library is distributed separately through Maven Central. + +## Welcome contributions + +- Clarify setup, authentication, headset/Virtual Brainwear prerequisites, and troubleshooting. +- Improve reproducible Java 21 and Maven examples using the published library API. +- Fix documentation errors and add helpful tests or explanations. +- Improve accessibility of examples and diagrams. + +## How to contribute + +1. Open a Bug Report or Documentation Improvement issue when useful. +2. Fork the repository and create a focused branch. +3. Make a small, documented change using the published library version unless the maintainer requests an update. +4. Run `mvn clean verify` and, when relevant, run the affected example with appropriate hardware or Virtual Brainwear. Explain any testing you could not perform. +5. Open a pull request against `main` and respond to maintainer feedback. A maintainer reviews changes before merging. + +Never commit EMOTIV credentials, tokens, personal data, raw participant recordings, or private library source code. Use synthetic or consent-appropriate data in examples and screenshots. + +See [Accessibility](ACCESSIBILITY.md) and the [Code of Conduct](CODE_OF_CONDUCT.md). From 2164360e915c2bbaac56d640e59e3ae6a236690f Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:19 -0700 Subject: [PATCH 2/8] docs: remove root CONTRIBUTING.md after relocation --- CONTRIBUTING.md | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index adee1db..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,22 +0,0 @@ -# Contributing to Cortex4J Getting Started - -Thank you for improving the public CORTEX4J learning materials. This repository contains examples and documentation for the published Cortex4J library; the library implementation is maintained separately in a private repository. - -## Welcome contributions - -- Clarify setup, authentication, headset/Virtual Brainwear prerequisites, and troubleshooting. -- Improve reproducible Java 21 and Maven examples using the published library API. -- Fix documentation errors and add helpful tests or explanations. -- Improve accessibility of examples and diagrams. - -## How to contribute - -1. Open a Bug Report or Documentation Improvement issue when useful. -2. Fork the repository and create a focused branch. -3. Make a small, documented change using the published library version unless the maintainer requests an update. -4. Run `mvn clean verify` and, when relevant, run the affected example with appropriate hardware or Virtual Brainwear. Explain any testing you could not perform. -5. Open a pull request against `main` and respond to maintainer feedback. A maintainer reviews changes before merging. - -Never commit EMOTIV credentials, tokens, personal data, raw participant recordings, or private library source code. Use synthetic or consent-appropriate data in examples and screenshots. - -See [Accessibility](ACCESSIBILITY.md) and the [Code of Conduct](CODE_OF_CONDUCT.md). From 5ddce9dc7ccfa413a0a9ee7b48bb057a60431042 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:22 -0700 Subject: [PATCH 3/8] docs: relocate CODE_OF_CONDUCT.md to .github --- .github/CODE_OF_CONDUCT.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e8fd48d --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,20 @@ +# Code of Conduct + +## Our commitment + +We welcome students, educators, developers, and contributors of all backgrounds. Please help maintain a respectful and constructive learning environment. + +## Expected behavior + +- Be considerate, patient, and professional in issues, pull requests, and discussions. +- Offer actionable feedback about code and documentation, not personal criticism. +- Respect different experience levels and accessibility needs. +- Protect others' privacy; do not publish personal information or credentials. + +Harassment, discriminatory language, intimidation, and personal attacks are not acceptable. + +## Reporting and enforcement + +If you experience or witness unacceptable behavior, contact the repository maintainer privately through their GitHub profile rather than posting sensitive details in a public issue. Maintainers may edit or remove inappropriate content, close discussions, or restrict participation when needed. Reports will be handled as discreetly as reasonably possible; confidentiality cannot be guaranteed. + +This policy applies to project spaces, including issues, pull requests, and project discussions. From dbc7ba91c7268fe7a8fa9e09cc9e18086c8333dc Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:23 -0700 Subject: [PATCH 4/8] docs: remove root CODE_OF_CONDUCT.md after relocation --- CODE_OF_CONDUCT.md | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index e8fd48d..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,20 +0,0 @@ -# Code of Conduct - -## Our commitment - -We welcome students, educators, developers, and contributors of all backgrounds. Please help maintain a respectful and constructive learning environment. - -## Expected behavior - -- Be considerate, patient, and professional in issues, pull requests, and discussions. -- Offer actionable feedback about code and documentation, not personal criticism. -- Respect different experience levels and accessibility needs. -- Protect others' privacy; do not publish personal information or credentials. - -Harassment, discriminatory language, intimidation, and personal attacks are not acceptable. - -## Reporting and enforcement - -If you experience or witness unacceptable behavior, contact the repository maintainer privately through their GitHub profile rather than posting sensitive details in a public issue. Maintainers may edit or remove inappropriate content, close discussions, or restrict participation when needed. Reports will be handled as discreetly as reasonably possible; confidentiality cannot be guaranteed. - -This policy applies to project spaces, including issues, pull requests, and project discussions. From eb86d87443bcec7fb7c67573c227717f41a09f4e Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:26 -0700 Subject: [PATCH 5/8] docs: relocate SECURITY.md to .github --- .github/SECURITY.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/SECURITY.md diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..e094a32 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +This repository contains educational examples and documentation for Cortex4J. Please do not post credentials, access tokens, private keys, personal data, or sensitive device information in issues or pull requests. + +## Reporting a vulnerability + +If you discover a potential security vulnerability, please **do not open a public issue**. Use GitHub's **Report a vulnerability** option under the repository's Security tab if available. If private reporting is unavailable, contact the repository maintainer privately through their GitHub profile before sharing details publicly. + +For ordinary bugs in examples or documentation, use the bug report issue template. Never include real credentials in logs or screenshots. + +## Supported content + +The latest version of the examples on the default branch is the primary maintained version. Older snapshots may not receive fixes. This repository does not publish or maintain the underlying library implementation. From a26e11b0a7af3cba03fc30f08a5692c8e55976f9 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:28 -0700 Subject: [PATCH 6/8] docs: remove root SECURITY.md after relocation --- SECURITY.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index e094a32..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,13 +0,0 @@ -# Security Policy - -This repository contains educational examples and documentation for Cortex4J. Please do not post credentials, access tokens, private keys, personal data, or sensitive device information in issues or pull requests. - -## Reporting a vulnerability - -If you discover a potential security vulnerability, please **do not open a public issue**. Use GitHub's **Report a vulnerability** option under the repository's Security tab if available. If private reporting is unavailable, contact the repository maintainer privately through their GitHub profile before sharing details publicly. - -For ordinary bugs in examples or documentation, use the bug report issue template. Never include real credentials in logs or screenshots. - -## Supported content - -The latest version of the examples on the default branch is the primary maintained version. Older snapshots may not receive fixes. This repository does not publish or maintain the underlying library implementation. From 02390361cd793cd68c8997cc6df7f650a0f0028c Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:31 -0700 Subject: [PATCH 7/8] docs: relocate ACCESSIBILITY.md to .github --- .github/ACCESSIBILITY.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ACCESSIBILITY.md diff --git a/.github/ACCESSIBILITY.md b/.github/ACCESSIBILITY.md new file mode 100644 index 0000000..2e92b40 --- /dev/null +++ b/.github/ACCESSIBILITY.md @@ -0,0 +1,18 @@ +# Accessibility + +We aim to make the CORTEX4J Getting Started examples and documentation usable by learners with different abilities, devices, and experience levels. + +## Documentation and examples + +- Use descriptive headings, meaningful link text, and plain language. +- Provide descriptive alternative text for informative images and diagrams; explain essential visual information in nearby text. +- Do not rely on color alone to communicate meaning. +- Keep commands, example output, and configuration instructions available as selectable text. +- Prefer keyboard-accessible tools and document alternatives when a graphical interface is required. +- Clearly distinguish optional hardware or external services from requirements; provide simulator or offline alternatives where feasible, without claiming they reproduce physical hardware. + +## Report an accessibility barrier + +Use the repository's **Documentation Improvement** issue template to describe the affected page or example, the barrier, and a suggested improvement if possible. You do not need to disclose a disability or personal medical information. + +Accessibility is an ongoing effort, not a claim of formal certification or full conformance to a particular standard. From b03dbb930b068cee7f92848acc117f11214d4fc1 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez <3814755+javiergs@users.noreply.github.com> Date: Fri, 30 Oct 2026 21:33:33 -0700 Subject: [PATCH 8/8] docs: remove root ACCESSIBILITY.md after relocation --- ACCESSIBILITY.md | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 ACCESSIBILITY.md diff --git a/ACCESSIBILITY.md b/ACCESSIBILITY.md deleted file mode 100644 index 2e92b40..0000000 --- a/ACCESSIBILITY.md +++ /dev/null @@ -1,18 +0,0 @@ -# Accessibility - -We aim to make the CORTEX4J Getting Started examples and documentation usable by learners with different abilities, devices, and experience levels. - -## Documentation and examples - -- Use descriptive headings, meaningful link text, and plain language. -- Provide descriptive alternative text for informative images and diagrams; explain essential visual information in nearby text. -- Do not rely on color alone to communicate meaning. -- Keep commands, example output, and configuration instructions available as selectable text. -- Prefer keyboard-accessible tools and document alternatives when a graphical interface is required. -- Clearly distinguish optional hardware or external services from requirements; provide simulator or offline alternatives where feasible, without claiming they reproduce physical hardware. - -## Report an accessibility barrier - -Use the repository's **Documentation Improvement** issue template to describe the affected page or example, the barrier, and a suggested improvement if possible. You do not need to disclose a disability or personal medical information. - -Accessibility is an ongoing effort, not a claim of formal certification or full conformance to a particular standard.