Skip to content

Commit e33a7ae

Browse files
address review comments on DPC conventions alignment
Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com> Agent-Logs-Url: https://github.com/Dans-Plugins/Currencies/sessions/5694b649-0f2d-484a-acab-b70b9dcddf20
1 parent 1f1a450 commit e33a7ae

5 files changed

Lines changed: 34 additions & 18 deletions

File tree

.github/copilot-instructions.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,17 @@ making any changes.
1414
## Project Structure
1515

1616
- `src/main/kotlin/` – Plugin source code
17-
- `src/main/resources/``plugin.yml`, `config.yml`, and `lang/` files
17+
- `src/main/resources/``plugin.yml`, `config.yml`, and other resource files
1818
- `src/test/kotlin/` – Unit tests
1919
- `.github/workflows/` – CI and release workflows
2020

2121
## Coding Conventions
2222

23-
- Use the `lang/` resource files for every user-facing string; never hard-code
24-
messages in Kotlin.
23+
- Prefer using `lang/` resource files for user-facing strings. When introducing new
24+
messages, avoid hard-coding them in Kotlin where a suitable `lang/` resource
25+
structure already exists in this project.
2526
- Follow the existing package structure when adding new classes.
26-
- Annotate every command executor and event listener with `@Override` where applicable.
27+
- In Kotlin, use the `override` keyword for overridden members, and annotate Bukkit event listener methods with `@EventHandler`.
2728
- This plugin depends on Medieval Factions; use its API where faction data is needed.
2829

2930
## Contribution Workflow

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ jobs:
2929
- name: Upload JAR to release
3030
uses: softprops/action-gh-release@v2
3131
with:
32-
files: build/libs/*.jar
32+
files: build/libs/*-all.jar

COMMANDS.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
### /currency info \<currency\>
2424

2525
**Description:** View information about a specific currency.
26-
**Permission:** `currencies.list`
26+
**Permission:** None (available to all players)
2727
**Usage:** `/currency info <currency>`
2828
**Example:** `/currency info GoldCoin`
2929

@@ -47,9 +47,19 @@
4747

4848
---
4949

50+
### /currency set name \<currency\> \<new-name\>
51+
52+
**Description:** Set the name of an existing currency. Requires the appropriate faction permission or `currencies.force.rename`.
53+
**Aliases:** `/currency rename <currency> <new-name>`
54+
**Permission:** `currencies.rename`
55+
**Usage:** `/currency set name <currency> <new-name>`
56+
**Example:** `/currency set name GoldCoin SilverCoin`
57+
58+
---
59+
5060
### /currency rename \<currency\> \<new-name\>
5161

52-
**Description:** Rename an existing currency. Requires the appropriate faction permission or `currencies.force.rename`.
62+
**Description:** Alias for `/currency set name`. Rename an existing currency. Requires the appropriate faction permission or `currencies.force.rename`.
5363
**Permission:** `currencies.rename`
5464
**Usage:** `/currency rename <currency> <new-name>`
5565
**Example:** `/currency rename GoldCoin SilverCoin`
@@ -59,6 +69,7 @@
5969
### /currency set description \<currency\> \<description\>
6070

6171
**Description:** Set or update the description of a currency. Requires the appropriate faction permission or `currencies.force.desc`.
72+
**Aliases:** `/currency set desc <currency> <description>`
6273
**Permission:** `currencies.desc`
6374
**Usage:** `/currency set description <currency> <description>`
6475
**Example:** `/currency set description GoldCoin "The official coin of the Northern Kingdom"`

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Issues are grouped into [milestones](https://github.com/Dans-Plugins/Currencies/
4949

5050
### Language Files
5151

52-
Update `src/main/resources/lang/` for any user-facing string changes.
52+
For any user-facing string changes, update the appropriate resource files under `src/main/resources/` (for example, `plugin.yml` or `config.yml`). If you add a new localization or language file structure, document it in your pull request.
5353

5454
## Testing
5555

@@ -58,9 +58,13 @@ Run the unit tests with:
5858
Linux: `./gradlew clean test`
5959
Windows: `.\gradlew.bat clean test`
6060

61-
For manual testing, start a local Spigot server:
61+
For manual testing, start a local Spigot server using the helper script:
6262

63-
docker compose up
63+
./up.sh
64+
65+
To stop the local Spigot server when you're done testing:
66+
67+
./down.sh
6468

6569
## Questions
6670

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,6 @@ You are free to use, modify, and distribute this software, provided that:
9999

100100
See the [LICENSE](LICENSE) file for the full text of the GPL-3.0 license.
101101

102-
## Project Status
103-
104-
This project is in active development.
105-
106-
### bStats
107-
108-
You can view the bStats page for the plugin [here](https://bstats.org/plugin/bukkit/Currencies/12810).
109-
110102
## Roadmap
111103

112104
- [Known Bugs](https://github.com/Dans-Plugins/Currencies/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
@@ -116,3 +108,11 @@ You can view the bStats page for the plugin [here](https://bstats.org/plugin/buk
116108
## Changelog
117109

118110
- [CHANGELOG.md](CHANGELOG.md)
111+
112+
## Project Status
113+
114+
This project is in active development.
115+
116+
### bStats
117+
118+
You can view the bStats page for the plugin [here](https://bstats.org/plugin/bukkit/Currencies/12810).

0 commit comments

Comments
 (0)