root directory cleanup

develop/GUIDES.md

@@ -0,0 +1,22 @@
+# Guidelines
+
+## Checklists
+
+### New Version Releasing
+
+1. Ensure all tests pass on CI.
+2. Update the version number in `evolved.lua`.
+3. Update the **Changelog** section in `README.md`.
+4. Create a new rockspec file in `rockspecs`.
+5. Commit the changes with a message like `vX.Y.Z`.
+6. Push and merge the changes to the `main` branch.
+7. Create the release on GitHub.
+8. Upload the new package to LuaRocks.
+
+### Adding a New Top-Level Function
+1. Insert the new function into the `evolved` table in `evolved.lua`.
+2. Create tests for the function in `develop/testing/function_name_tests.lua`.
+3. Add the new test to `develop/all.lua`.
+4. Document the function in the **Cheat Sheet** and **API Reference** sections of `README.md`.
+5. Provide a description in the **Overview** section of `README.md`.
+6. Describe the update in the **Changelog** section of `README.md`.

develop/ROADMAP.md

@@ -0,0 +1,18 @@
+# Roadmap
+
+## Backlog
+
+- observers and events
+- add INDEX fragment trait
+- use compact prefix-tree for chunks
+- optional ffi component storages
+
+## Thoughts
+
+- We can return deferred status from modifying operations and spawn/clone methods.
+- We should have a way to not copy components on deferred spawn/clone.
+
+## Known Issues
+
+- Required fragments are slower than they should be
+- Errors in hooks are cannot be handled properly right now

develop/all.lua

@@ -3,6 +3,7 @@ require 'develop.samples.systems'
 require 'develop.testing.build_tests'
 require 'develop.testing.cancel_tests'
 require 'develop.testing.locate_tests'
+require 'develop.testing.main_tests'
 require 'develop.testing.multi_spawn_tests'
 require 'develop.testing.name_tests'
 require 'develop.testing.requires_fragment_tests'
@@ -15,8 +16,6 @@ require 'develop.benchmarks.process_bmarks'
 require 'develop.benchmarks.spawn_bmarks'
 require 'develop.benchmarks.table_bmarks'
 
-require 'develop.untests'
-
 local basics = require 'develop.basics'
 
 print '----------------------------------------'