-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
60 changed files
with
4,365 additions
and
870 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Welcome to the Shops contributing guidelines | ||
|
|
||
| Thank you for investing your time in contributing to this project! Any contribution you make will be reflected in the [Shops contributors](https://github.com/BrendonButler/Shops/graphs/contributors). | ||
|
|
||
| Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable. | ||
|
|
||
| In this guide you will get an overview of the contribution workflow from forking the repository, creating a PR, reviewing, and merging the PR. | ||
|
|
||
| To get an overview of the project, read the [README](README.md). | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Pre-requisites | ||
|
|
||
| 1. Have [Git](https://github.com/git-guides/install-git) installed and [configured](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) on your machine | ||
| 2. [Fork the Shops repository](https://github.com/BrendonButler/Shops/fork) into your own account | ||
| 3. Optional: Utilize the Project codestyle for reformatting changes <br>_found here: `Shops/.idea/codeStyles/Project.xml`_ | ||
|
|
||
| ### Issues/Features | ||
|
|
||
| #### Create a new issue/feature request | ||
|
|
||
| If you identify an issue or want to make a suggestion, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/BrendonButler/Shops/issues/new). | ||
|
|
||
| #### Solve an issue or implement a feature | ||
|
|
||
| If an issue doesn't exist for a feature you want to implement, please create an issue first for pre-review. Once it's determined that the feature should be implemented, and you get feedback from owners on the repo, feel free to work on the issue and create a PR. | ||
|
|
||
| Scan through the [existing issues](https://github.com/BrendonButler/Shops/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. | ||
|
|
||
| #### Make changes locally | ||
|
|
||
| 1. Fork the repository. | ||
| - Using GitHub Desktop: | ||
| - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. | ||
| - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! | ||
|
|
||
| - Using the command line: | ||
| - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. | ||
|
|
||
| 2. Create a working branch and start with your changes! | ||
| - Create a branch with the appropriate prefix for the issue type: | ||
| - `feature/GH-{ISSUE_NUM}` - use the "feature/GH-##" prefix to create the new feature branch | ||
| - `fix/GH-{ISSUE_NUM}` - use the "fix/GH-##" prefix to create a fix branch for bugs and other issues | ||
|
|
||
| ### Commit your update | ||
|
|
||
| When creating commits, please use this format and if there are multiple updates that don't make sense to be added to the specific issue ID, you can create a new line for another issue: | ||
| - `GH-123 add CreateCommand to create stores` | ||
| - `GH-9999 fix command sender validation in CreateCommand` | ||
| - `update README links` | ||
|
|
||
| This will ensure fantastic traceability on issues and how the commits relate. For updates such as README enhancements, you can omit the issue tag. These tags will be clickable in the commit history to quickly bring up the issue. | ||
|
|
||
| ### Pull Request | ||
|
|
||
| When you're finished with the changes, create a pull request, also known as a PR. | ||
| - Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. | ||
| - Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. | ||
| Once you submit your PR, a project admin will review your proposal. We may ask questions or request additional information. | ||
| - We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. | ||
| - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). | ||
| - If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,52 @@ | ||
| # Shops | ||
| [](https://github.com/MrSparkzz/Shops/actions/workflows/pipeline.yml) | ||
|  | ||
| [](https://github.com/BrendonButler/Shops/actions/workflows/pipeline.yml) | ||
| [](https://app.codecov.io/github/BrendonButler/Shops)<br> | ||
| [](https://github.com/BrendonButler/Shops/releases) | ||
| [](https://www.curseforge.com/minecraft/bukkit-plugins/command-shops) | ||
| <br> | ||
| <!--[](https://www.curseforge.com/minecraft/bukkit-plugins/command-shops/files)--> | ||
|
|
||
| Shops plugin for Bukkit/Spigot 2022+ [Built for Spigot 1.18] | ||
| Shops plugin for Bukkit/Spigot 2022+ | ||
|
|
||
|  | ||
|
|
||
| **Depends on:** [Vault](https://github.com/MilkBowl/Vault) | ||
|
|
||
| **Requires economy plugin (compatible with Vault) such as:** [EssentialsX](https://github.com/EssentialsX/Essentials) | ||
|
|
||
| ### What is Shops? | ||
| _Shops is a vanilla-style, command-driven shopping plugin for Spigot Servers._ | ||
|
|
||
| As a shopping plugin, you can create location based stores and add/remove/update items in the inventory for your (stores). | ||
| For _customers_, when in a store, you can buy items from the store, sell items to the store, and browse the store's catalog. | ||
|
|
||
| ### Why Command Shops? | ||
| Really this stemmed from nostalgia when I used to play on my friend's cousin's Minecraft server where it used Towny and | ||
| some location-based shopping plugin to make for an ultimate survival multiplayer server. Back then, most of your | ||
| plugins would be controlled through commands instead of UI elements. | ||
|
|
||
| With _newer_ features such as tab complete to autofill suggested command arguments such as online players and | ||
| materials, it really makes these command shops even easier to interact with. Sure, pulling up an inventory UI may be | ||
| much more simple and intuitive for players, I'm sure there are still server operators that enjoy a more vanilla | ||
| approach, accomplished by commands. | ||
|
|
||
| I intend to use this on my personal server(s) with friends/family as well. So this was really created as a personal | ||
| project that I could learn from. | ||
|
|
||
| ### What if there's a feature I feel is missing? | ||
| I believe I have thought of most of the features that I _want_ to implement, but I am definitely open to suggestions. | ||
| If you would like to make a new request, please visit the [issues page](https://github.com/BrendonButler/Shops/issues?q=is%3Aissue) | ||
| on GitHub and search for keywords in your feature/request. If you can't find an existing or closed issue, please feel | ||
| free to click "New Issue" and try to fill it out in detail with what you would like to see added or improved and why. | ||
|
|
||
| Being detailed in your request and explaining the need/want clearly will aid in my decision of whether I deem the | ||
| feature or request to be in accordance with my goals for this project. | ||
|
|
||
| ### How can I contribute? | ||
| If you're looking to implement any of the [open issues](https://github.com/BrendonButler/Shops/issues) please review | ||
| the [Contributing Guidelines](https://github.com/BrendonButler/Shops/blob/develop/CONTRIBUTING.md). | ||
|
|
||
| This can be a great way to add projects and workflows to your portfolio and resumé. | ||
|
|
||
| I would like to restate the importance of following the [Contributing Guidelines](https://github.com/BrendonButler/Shops/blob/develop/CONTRIBUTING.md) carefully as to make the review process | ||
| smoother. |
Oops, something went wrong.