Merge pull request #99 from brack-lang/develop

Release v0.2.0-rc.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,69 @@
+---
+name: Bug report
+about: Create a detailed bug report to help us improve Brack
+title: 'Bug: '
+labels: 'type: bug'
+assignees: ''
+
+---
+
+### Describe the bug
+Provide a clear and detailed description of the issue. Include any relevant error messages or logs that can help diagnose the problem.
+
+### Steps to reproduce
+Detail the steps needed to reproduce the bug. Make sure to be as specific as possible:
+
+1. ...
+2. ...
+3. ...
+
+### Expected behavior
+Describe what you expected to happen instead of the actual outcome.
+
+### Actual behavior
+Explain what actually happened. If there are error messages, include them here.
+
+### Component (optional)
+If you know which component your issue relates to, please select it:
+
+- [ ] CLI tools (brack)
+- [ ] Tokenizer (brack-tokenizer)
+- [ ] Parser (brack-parser)
+- [ ] Transformer (brack-transformer)
+- [ ] Macro Expander (brack-expander)
+- [ ] Lower (brack-lower)
+- [ ] Code Generator (brack-codegen)
+- [ ] Infrastructure
+- [ ] Language Server (brack-language-server)
+- [ ] Project Manager (brack-project-manager)
+- [ ] GitHub Actions
+
+### Environment (please complete the following information)
+- OS: [e.g., macOS, Windows, Linux]
+- Brack version: [e.g., v0.1.0]
+- Any additional dependencies or configurations (e.g., plugins)
+
+### Screenshots or logs (optional)
+If applicable, provide screenshots or attach logs to help illustrate the problem. If you are comfortable sharing them, this can greatly assist in identifying the issue.
+
+### Additional context
+Add any other relevant context or details that might help in resolving the issue, such as specific configurations, custom settings, or unusual usage scenarios.
+
+### Metadata
+Please run `brack version` and paste the output below.
+
+```console
+$ brack version
+<output here>
+```
+
+### Steps taken to verify
+Before submitting, ensure you've done the following checks:
+
+- [ ] Confirmed that the bug is not caused by any plugins
+- [ ] Searched [open bug issues] to avoid duplicates
+- [ ] Reviewed [open bug pull requests] for possible solutions
+
+[open bug issues]: https://github.com/brack-lang/brack/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+bug%22
+[open bug pull requests]: https://github.com/brack-lang/brack/pulls?q=is%3Aopen+is%3Apr+label%3A%22type%3A+bug%22
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,51 @@
+---
+name: Feature request
+about: Suggest a new feature or improvement for Brack
+title: 'Enhancement: '
+labels: 'type: enhancement'
+assignees: ''
+
+---
+
+### Describe the feature or improvement
+Provide a clear and detailed description of the feature or improvement you'd like to see in Brack. Explain why this feature would be useful and any specific use cases or examples where it would be applied.
+
+### Suggested implementation (optional)
+If you have an idea of how this feature could be implemented, please share it here. This can include pseudo-code, specific behaviors, or references to similar features in other tools or languages.
+
+### Component (optional)
+If you know which component your issue relates to, please select it:
+
+- [ ] CLI tools (brack)
+- [ ] Tokenizer (brack-tokenizer)
+- [ ] Parser (brack-parser)
+- [ ] Transformer (brack-transformer)
+- [ ] Macro Expander (brack-expander)
+- [ ] Lower (brack-lower)
+- [ ] Code Generator (brack-codegen)
+- [ ] Infrastructure
+- [ ] Language Server (brack-language-server)
+- [ ] Project Manager (brack-project-manager)
+- [ ] GitHub Actions
+
+### Additional context
+Add any other relevant context or details that might help clarify the feature request, such as related tools or other relevant features.
+
+### Reference (optional)
+If this feature request has been discussed or inspired elsewhere, please include links to relevant discussions:
+
+- [ ] GitHub Issue (ref: <!-- please paste issue link -->)
+- [ ] GitHub Pull Request (ref: <!-- please paste pr link -->)
+- [ ] GitHub Discussion (ref: <!-- please paste discussion link -->)
+- [ ] Discord Server (ref: <!-- please paste message link -->)
+
+### Steps taken to verify
+Before submitting, ensure you've done the following checks:
+
+- [ ] Confirmed that a similar feature request does not already exist
+- [ ] Searched [open enhancement issues] to avoid duplicates
+- [ ] Reviewed [open enhancement pull requests] for possible solutions
+
+[open enhancement issues]: https://github.com/brack-lang/brack/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+enhancement%22
+[open enhancement pull requests]: https://github.com/brack-lang/brack/pulls?q=is%3Aopen+is%3Apr+label%3A%22type%3A+enhancement%22
+

.github/ISSUE_TEMPLATE/missing_or_incorrect_documentation.md

@@ -0,0 +1,49 @@
+---
+name: Missing or incorrect documentation
+about: Help us improve the Brack documentation
+title: 'Documentation: '
+labels: 'type: documentation'
+assignees: ''
+
+---
+
+### Describe the issue
+Provide a clear and detailed description of the documentation problem or missing information. Include specific sections or commands that are unclear, incorrect, or absent.
+
+### Suggested improvements
+Explain what could be added or changed to improve the documentation. If applicable, suggest specific wording or examples that would clarify the content.
+
+### Component (optional)
+If you know which component your issue relates to, please select it:
+
+- [ ] CLI tools (brack)
+- [ ] Tokenizer (brack-tokenizer)
+- [ ] Parser (brack-parser)
+- [ ] Transformer (brack-transformer)
+- [ ] Macro Expander (brack-expander)
+- [ ] Lower (brack-lower)
+- [ ] Code Generator (brack-codegen)
+- [ ] Infrastructure
+- [ ] Language Server (brack-language-server)
+- [ ] Project Manager (brack-project-manager)
+- [ ] GitHub Actions
+
+### Reference (optional)
+If this issue has been discussed elsewhere, please include links to relevant discussions:
+
+- [ ] GitHub Issue (ref: <!-- please paste issue link -->)
+- [ ] GitHub Pull Request (ref: <!-- please paste pr link -->)
+- [ ] GitHub Discussion (ref: <!-- please paste discussion link -->)
+- [ ] Discord Server (ref: <!-- please paste message link -->)
+
+### Steps taken to verify
+Before submitting, ensure you've reviewed the latest version of the documentation:
+
+- [ ] Checked [latest README] and [latest doc]
+- [ ] Searched [open documentation issues] to avoid duplicates
+- [ ] Reviewed [open documentation pull requests] for possible solutions
+
+[latest README]: https://github.com/brack-lang/brack/blob/develop/README.md
+[latest doc]: https://github.com/brack-lang/brack/tree/develop/doc
+[open documentation issues]: https://github.com/brack-lang/brack/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+documentation%22
+[open documentation pull requests]: https://github.com/brack-lang/brack/pulls?q=is%3Aopen+is%3Apr+label%3A%22type%3A+documentation%22

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,50 @@
+---
+name: Question
+about: Ask a question about Brack usage, features, or development
+title: 'Question: '
+labels: 'type: question'
+assignees: ''
+
+---
+
+### Question
+Please provide a clear and concise question about Brack. Explain the context behind your question, such as what you're trying to achieve or any specific problem you're facing.
+
+### Component (optional)
+If you know which component your issue relates to, please select it:
+
+- [ ] CLI tools (brack)
+- [ ] Tokenizer (brack-tokenizer)
+- [ ] Parser (brack-parser)
+- [ ] Transformer (brack-transformer)
+- [ ] Macro Expander (brack-expander)
+- [ ] Lower (brack-lower)
+- [ ] Code Generator (brack-codegen)
+- [ ] Infrastructure
+- [ ] Language Server (brack-language-server)
+- [ ] Project Manager (brack-project-manager)
+- [ ] GitHub Actions
+
+### What you've tried (optional)
+If you've already tried certain solutions or approaches, please describe them here. This will help others understand what has or hasn't worked for you.
+
+### Additional context
+If applicable, provide any additional information that might help others understand your question. This can include code snippets, configurations, or specific use cases.
+
+### Reference (optional)
+If your question has been discussed or referenced elsewhere, please include links to relevant discussions:
+
+- [ ] GitHub Issue (ref: <!-- please paste issue link -->)
+- [ ] GitHub Pull Request (ref: <!-- please paste pr link -->)
+- [ ] GitHub Discussion (ref: <!-- please paste discussion link -->)
+- [ ] Discord Server (ref: <!-- please paste message link -->)
+
+### Steps taken to verify
+Before submitting your question, please make sure:
+
+- [ ] Searched [open questions] to ensure it hasn't already been answered
+- [ ] Reviewed [documentation] for relevant information
+
+[open questions]: https://github.com/brack-lang/brack/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+question%22
+[documentation]: https://github.com/brack-lang/brack/tree/develop/doc
+

.github/pull_request_template.md

@@ -0,0 +1,48 @@
+### Description
+Please provide a clear and concise description of the changes in this pull request. Indicate whether the changes are related to documentation, bug fixes, or feature implementation:
+
+- [ ] Documentation
+- [ ] Bug Fix
+- [ ] Feature Implementation
+
+### Component
+Select the relevant component that your changes apply to:
+
+- [ ] Brack (CLI tools)
+- [ ] Tokenizer
+- [ ] Parser
+- [ ] Transformer
+- [ ] Lower
+- [ ] Code Generator (codegen)
+- [ ] Commands Expander (expander)
+- [ ] Infrastructure (release automation)
+- [ ] Language Server (language-server)
+- [ ] Plugin Manager (plugin-manager)
+- [ ] Workflow (continuous integration)
+
+### Related Issue or Reference (optional)
+If this pull request addresses or references any issues, pull requests, or discussions, please provide the relevant links here:
+
+- [ ] GitHub Issue (ref: <!-- please paste issue link -->)
+- [ ] GitHub Pull Request (ref: <!-- please paste pr link -->)
+- [ ] GitHub Discussion (ref: <!-- please paste discussion link -->)
+- [ ] Discord Server (ref: <!-- please paste message link -->)
+
+### Tests and Verification
+Please describe any tests you have performed to verify the changes. Include any specific commands, scripts, or manual steps followed to ensure the functionality works as expected.
+
+- [ ] Unit Tests
+- [ ] Integration Tests
+- [ ] Manual Testing
+
+### Additional Context
+If there is any other information that may be helpful in understanding this pull request, such as screenshots, log files, or explanations of design decisions, please include it here.
+
+### Steps taken to verify
+Before submitting this pull request, please ensure the following:
+
+- [ ] Confirmed that the changes do not introduce any new issues or bugs
+- [ ] Searched [open issues] and [open pull requests] to avoid duplicates
+
+[open issues]: https://github.com/brack-lang/brack/issues?q=is%3Aopen+is%3Aissue
+[open pull requests]: https://github.com/brack-lang/brack/pulls?q=is%3Aopen+is%3Apr

.github/workflows/ci.yml

@@ -6,14 +6,14 @@ on:
       - '.gitignore'
       - 'LICENSE*'
       - 'brack.*.ebnf'
-      - '*.md'
+      - '**/*.md'
   pull_request:
     paths-ignore:
       - '.vscode/**'
       - '.gitignore'
       - 'LICENSE*'
       - 'brack.*.ebnf'
-      - '*.md'
+      - '**/*.md'
 
 jobs:
   test:

.github/workflows/main.yml

@@ -23,13 +23,18 @@ jobs:
         id: version
         run: |
           echo "version=$(cat ./VERSION)" >> $GITHUB_OUTPUT
+      - name: Generate release note
+        id: release-note
+        run: |
+          bash scripts/release-note.sh v${{ steps.version.outputs.version }} 2>/dev/null | tee release_notes.md
       - name: Create release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tag_name: v${{ steps.version.outputs.version }}
           release_name: v${{ steps.version.outputs.version }}
+          body_path: release_notes.md
           draft: false
           prerelease: false