EverMind-AI · cyfyifanchen · May 6, 2026 · May 6, 2026 · May 6, 2026 · May 6, 2026
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,33 @@
+# Code of Conduct
+
+EverOS should be a welcoming place for researchers, builders, maintainers, and
+first-time contributors.
+
+## Expected Behavior
+
+- Be respectful and constructive.
+- Assume good intent, especially across language and culture differences.
+- Give feedback on ideas and code, not on people.
+- Help newcomers find the right context when they are missing it.
+- Keep discussions focused on improving the project.
+
+## Unacceptable Behavior
+
+- Harassment, threats, insults, or personal attacks.
+- Discriminatory language or behavior.
+- Publishing private information without permission.
+- Repeatedly derailing issues, pull requests, or discussions.
+- Any conduct that would make the project unsafe or unwelcoming.
+
+## Reporting
+
+If you see or experience unacceptable behavior, contact the maintainers through
+GitHub Discussions or the community channels linked in the README. Maintainers
+may remove comments, close threads, or restrict participation when needed to
+protect the community.
+
+## Scope
+
+This code of conduct applies to project spaces, including GitHub issues, pull
+requests, discussions, documentation, community chats, and events connected to
+EverOS.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,83 @@
+# Contributing to EverOS
+
+Thanks for helping improve EverOS. This repository brings together architecture
+methods, benchmarks, and use cases for long-term memory in self-evolving agents,
+so there are several useful ways to contribute.
+
+## Ways to Contribute
+
+- Improve or extend an architecture method in `methods/`.
+- Add benchmark tasks, adapters, or reproducibility notes in `benchmarks/`.
+- Add a memory-enabled app, demo, or integration in `use-cases/`.
+- Fix documentation, examples, setup steps, or broken links.
+- Report bugs with clear reproduction steps and environment details.
+
+## Development Setup
+
+Most core development happens in EverCore:
+
+```bash
+git clone https://github.com/EverMind-AI/EverOS.git
+cd EverOS/methods/EverCore
+
+docker compose up -d
+uv sync
+cp env.template .env
+uv run python src/run.py
+```
+
+Verify the server:
+
+```bash
+curl http://localhost:1995/health
+```
+
+## Common Commands
+
+```bash
+cd methods/EverCore
+make test                     # Run tests
+make lint                     # Run formatting and i18n checks
+uv sync --group evaluation    # Install evaluation dependencies
+```
+
+## Pull Request Checklist
+
+Before opening a PR, please check:
+
+- The change is scoped to the relevant area: `methods/`, `benchmarks/`, or
+  `use-cases/`.
+- Setup or behavior changes are documented.
+- Tests or manual verification are included when relevant.
+- No secrets, `.env` files, generated build output, or dependency folders are
+  committed.
+- Active relative links in Markdown files resolve.
+
+## Use-Case Contributions
+
+Use cases should be easy for a new developer to inspect and run. Each use case
+should include:
+
+- A README with what it does, how to run it, and what memory feature it shows.
+- A small `.env.example` when configuration is required.
+- No committed images, build output, dependency folders, or secrets.
+
+Images should be hosted with GitHub user attachments or another external asset
+URL instead of committed to the repository.
+
+## Style Notes
+
+- Follow existing patterns before adding new abstractions.
+- EverCore I/O is async; use `await`.
+- EverCore is multi-tenant; keep data tenant-scoped.
+- Keep prompt changes aligned across
+  `methods/EverCore/src/memory_layer/prompts/en/` and
+  `methods/EverCore/src/memory_layer/prompts/zh/` when applicable.
+
+## Community
+
+Please keep discussions respectful, constructive, and welcoming. See
+`CODE_OF_CONDUCT.md` for expectations.
+
+By contributing, you agree that your contributions are licensed under the
+Apache License 2.0.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,54 @@
+name: Bug report
+description: Report a reproducible problem in EverOS
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for helping improve EverOS. Clear reproduction steps make bugs much faster to fix.
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      options:
+        - methods/EverCore
+        - methods/HyperMem
+        - benchmarks/EverMemBench
+        - benchmarks/EvoAgentBench
+        - use-cases
+        - documentation
+        - other
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: What happened?
+      description: Describe the bug and the behavior you expected.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. Go to ...
+        2. Run ...
+        3. See ...
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      placeholder: |
+        OS:
+        Python:
+        Node:
+        Docker:
+        Commit:
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs or screenshots
+      render: shell
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: EverOS Discussions
+    url: https://github.com/EverMind-AI/EverOS/discussions
+    about: Ask questions, share ideas, and discuss roadmap topics.
diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
@@ -0,0 +1,22 @@
+name: Documentation issue
+description: Report unclear, missing, or outdated documentation
+title: "[Docs]: "
+labels: ["documentation"]
+body:
+  - type: input
+    id: page
+    attributes:
+      label: Page or file
+      placeholder: README.md, methods/EverCore/docs/...
+    validations:
+      required: true
+  - type: textarea
+    id: issue
+    attributes:
+      label: What should be improved?
+    validations:
+      required: true
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested wording or structure
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,40 @@
+name: Feature request
+description: Suggest an improvement or new capability
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      options:
+        - architecture methods
+        - benchmarks
+        - use cases
+        - developer experience
+        - documentation
+        - other
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem or opportunity
+      description: What user need, research gap, or workflow pain does this address?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: Describe the change you would like to see.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
diff --git a/.github/ISSUE_TEMPLATE/use_case.yml b/.github/ISSUE_TEMPLATE/use_case.yml
@@ -0,0 +1,37 @@
+name: Use-case proposal
+description: Propose an app, demo, or integration for use-cases/
+title: "[Use Case]: "
+labels: ["use case"]
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: What does the use case demonstrate?
+    validations:
+      required: true
+  - type: textarea
+    id: memory
+    attributes:
+      label: Memory behavior
+      description: What should the agent remember, retrieve, or evolve over time?
+    validations:
+      required: true
+  - type: textarea
+    id: stack
+    attributes:
+      label: Stack and dependencies
+      description: List frameworks, services, models, or external APIs.
+  - type: textarea
+    id: run
+    attributes:
+      label: Run path
+      description: How should a new developer run or inspect it?
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Contribution checklist
+      options:
+        - label: I can include a README with setup instructions.
+        - label: I can avoid committing secrets, generated output, dependency folders, and image files.
+        - label: I can include `.env.example` if configuration is needed.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,80 +1,37 @@
-## Description
+## Summary
 
-<!-- Provide a clear and concise description of your changes -->
+<!-- What changed, and why? -->
 
-## Type of Change
+## Area
 
-<!-- Mark the relevant option with an 'x' -->
+<!-- Mark the relevant option with an x. -->
 
-- [ ] Bug fix (non-breaking change that fixes an issue)
-- [ ] New feature (non-breaking change that adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Documentation update
-- [ ] Refactoring (no functional changes)
-- [ ] Performance improvement
-- [ ] Test improvements
-- [ ] Build/CI/CD changes
+- [ ] Architecture method
+- [ ] Benchmark
+- [ ] Use case
+- [ ] Documentation
+- [ ] Developer experience
+- [ ] CI, build, or release
 
-## Related Issues
+## Verification
 
-<!-- Link to related issues using #issue_number or full URL -->
+<!-- List commands run, manual checks, screenshots, or reasons verification was not needed. -->
 
-Fixes #
-Relates to #
+```text
 
-## Changes Made
-
-<!-- List the main changes in this PR -->
-
--
--
--
-
-## Testing
-
-<!-- Describe the tests you ran to verify your changes -->
-
-- [ ] Tested locally with manual verification
-- [ ] Added/updated unit tests
-- [ ] Added/updated integration tests
-- [ ] All existing tests pass
-
-**Test Configuration:**
-- OS:
-- Python version:
-- Database versions (if relevant):
-
-**Test Results:**
-```
-# Paste relevant test output here
 ```
 
 ## Checklist
 
-<!-- Mark completed items with an 'x' -->
-
-- [ ] My code follows the project's [code style guidelines](../CONTRIBUTING.md#-code-style)
-- [ ] I have performed a self-review of my code
-- [ ] I have commented my code where necessary, particularly in complex areas
-- [ ] I have updated the documentation accordingly
-- [ ] My changes generate no new warnings or errors
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes
-- [ ] I have used [Gitmoji](https://gitmoji.dev/) in my commit messages
-- [ ] Any dependent changes have been merged and published
-
-## Screenshots (if applicable)
-
-<!-- Add screenshots to help explain your changes -->
-
-## Additional Notes
-
-<!-- Any additional information that reviewers should know -->
-
-## Breaking Changes
+- [ ] I kept the change scoped to the relevant area.
+- [ ] I updated docs, examples, or setup notes when behavior changed.
+- [ ] I added or updated tests when the change affects behavior.
+- [ ] I did not commit secrets, `.env` files, dependency folders, or generated output.
+- [ ] Active relative links in Markdown files resolve.
 
-<!-- If this PR introduces breaking changes, describe them and provide migration guidance -->
+## Notes for Reviewers
 
----
+<!-- Anything reviewers should pay special attention to? -->
 
-By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
+By submitting this pull request, I agree that my contribution is licensed under
+the Apache License 2.0.