From 29777885c9f1c7ae716a48f73a0bd26b691e3538 Mon Sep 17 00:00:00 2001 From: Alcheri Date: Fri, 1 May 2026 15:00:50 +1000 Subject: [PATCH 1/3] ci: standardise GitHub support files --- .github/ISSUE_TEMPLATE/bug_report.md | 42 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 36 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 54 +++++++++++++++++++++++ .github/labeler.yml | 37 ++++++++++++++++ .github/workflows/labeler.yml | 16 +++++++ 5 files changed, 185 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/labeler.yml create mode 100644 .github/workflows/labeler.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..758adc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Report a bug in this Limnoria plugin +title: "[BUG] " +labels: bug +assignees: '' +--- + +# Bug Report + +## Description + +Provide a clear description of the issue. + +What happened? +What did you expect to happen instead? + +## Steps to Reproduce + +1. Run command: +2. Describe the input or configuration used. +3. Describe the observed behaviour. + +## Expected Behaviour + +Describe the correct behaviour. + +## Environment + +- Limnoria version: +- Python version: +- Plugin version: +- Operating system: +- Running in channel or private message? + +## Logs + +Paste relevant log output here, if applicable. + +## Additional Context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..19c9764 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,36 @@ +--- +name: Feature request +about: Suggest an improvement or new feature +title: "[FEATURE] " +labels: enhancement +assignees: '' +--- + +# Feature Request + +## Summary + +Briefly describe the proposed feature. + +## Motivation + +Why would this feature improve the plugin? + +## Proposed Behaviour + +Describe the behaviour you would like to see. + +## Considerations + +Would this affect: + +- [ ] Configuration +- [ ] Command output +- [ ] Permissions or access control +- [ ] Network or API usage +- [ ] File handling +- [ ] Existing tests + +## Additional Context + +Add examples, screenshots, or links here if useful. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bda5882 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,54 @@ +# Pull Request + +## Summary + +Briefly describe the purpose of this pull request. + +- What problem does it solve? +- What feature does it add? +- What behaviour does it change? + +## Type of Change + +Please tick one: + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor +- [ ] Documentation update +- [ ] Configuration change +- [ ] Security improvement + +## Testing Performed + +Describe how this change was tested. + +- [ ] Ran plugin tests +- [ ] Ran lint checks +- [ ] Tested manually in Limnoria +- [ ] Verified command output +- [ ] Checked logs for errors + +If applicable, include sample commands and outputs. + +## Security and Stability + +Confirm where relevant: + +- [ ] Input validation remains safe +- [ ] Permissions or capability checks remain correct +- [ ] File paths are handled safely +- [ ] Secrets are not logged or committed +- [ ] No unrelated behaviour changed + +## Documentation Updated + +If relevant: + +- [ ] README updated +- [ ] CHANGELOG or release notes updated +- [ ] Configuration documentation updated + +## Additional Notes + +Add any extra context here. diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..62611a9 --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,37 @@ +plugin: + - changed-files: + - any-glob-to-any-file: + - __init__.py + - plugin.py + - config.py + - cooldown.py + - local/** + +docs: + - changed-files: + - any-glob-to-any-file: + - README.md + - LICENCE.md + - docs/** + +examples: + - changed-files: + - any-glob-to-any-file: + - examples/** + +tests: + - changed-files: + - any-glob-to-any-file: + - test.py + +packaging: + - changed-files: + - any-glob-to-any-file: + - pyproject.toml + - requirements.txt + +ci: + - changed-files: + - any-glob-to-any-file: + - .github/workflows/** + - .github/labeler.yml diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml new file mode 100644 index 0000000..c033ca8 --- /dev/null +++ b/.github/workflows/labeler.yml @@ -0,0 +1,16 @@ +name: Labeler + +on: + pull_request_target: + +jobs: + label: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + + steps: + - uses: actions/labeler@v5 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" From 1abb84122ae214e8fbce4868c49be3835f959a0f Mon Sep 17 00:00:00 2001 From: Alcheri Date: Fri, 1 May 2026 16:32:48 +1000 Subject: [PATCH 2/3] chore: standardise gitignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 2ee98f8..3bc7f95 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,9 @@ local/__pycache__/ .pytest_cache/ CACHEDIR.TAG +# Codex files +*.codex + # Virtual environments .venv/ venv/ From b1ec06ab0f15f4175c2b5275d792986284618139 Mon Sep 17 00:00:00 2001 From: Alcheri Date: Fri, 1 May 2026 16:48:46 +1000 Subject: [PATCH 3/3] docs: move supporting docs into docs folder --- docs/CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..4a75e4a --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributors + +This project is maintained by: + +- @Alcheri + +## Community Contributors + +GitHub automatically tracks all contributors to this repository. +You can view the full, up‑to‑date list here: + +[GitHub Contributors](https://github.com/Alcheri/Mem/graphs/contributors) + +If you have contributed code, documentation, or fixes, your name will appear there. + +## How to Contribute + +Contributions are welcome. +Please open a pull request with a clear description of the change. + +By submitting a contribution, you agree that your work may be modified, redistributed, or relicensed as part of the project. + +## Recognition + +Significant or sustained contributors may be added to the curated list above.