diff --git a/.vscode/settings.json b/.vscode/settings.json index b8d220a..36600ad 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -8,6 +8,7 @@ "markdown.extension.toc.levels": "2..6", "markdown.extension.toc.omittedFromToc": { "README.md": [ + "# Changelog", "# API Reference" ] } diff --git a/GUIDES.md b/GUIDES.md new file mode 100644 index 0000000..3763684 --- /dev/null +++ b/GUIDES.md @@ -0,0 +1,11 @@ +# Guidelines + +## Checklists + +### 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`. diff --git a/README.md b/README.md index 71a435e..4b61406 100644 --- a/README.md +++ b/README.md @@ -1123,6 +1123,12 @@ builder_mt:destruction_policy :: id -> builder `evolved.lua` is licensed under the [MIT License][license]. For more details, see the [LICENSE.md](./LICENSE.md) file in the repository. +# Changelog + +## v1.0.0 + +- Initial release + # API Reference ## Predefs