📝 docs: update contributing guide with streamlined instructions

- Simplified and restructured the contributing guide for clarity.
- Removed redundant sections and outdated content.
- Added specific instructions for:
  - Setting up the project locally
  - Adding or modifying commands
  - Running quality checks
- Updated project structure overview and command flow details.
- Included security reporting guidelines and pull request checklist for contributors.

These updates aim to improve contributor onboarding and streamline the contribution process.

Author: notthebestdev

CONTRIBUTING.md

@@ -1,164 +1,140 @@
-<!-- omit in toc -->
-
 # Contributing to SomeoneBack
 
-> [!IMPORTANT]
-> This document is a work in progress and may be incomplete. Thank you for your understanding.
-
-First off, thanks for taking the time to contribute! ❤️
-
-All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+Thanks for wanting to contribute.
 
-> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
->
-> - Star the project
-> - Tweet about it
-> - Refer this project in your project's readme
-> - Mention the project at local meetups and tell your friends/colleagues
-
-<!-- omit in toc -->
+This project is a Discord bot running on Cloudflare Workers with `discord-hono` and TypeScript.
 
 ## Table of Contents
 
-- [I Have a Question](#i-have-a-question)
-  - [I Want To Contribute](#i-want-to-contribute)
-  - [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
-  - [Your First Code Contribution](#your-first-code-contribution)
-  - [Improving The Documentation](#improving-the-documentation)
-- [Styleguides](#styleguides)
-  - [Commit Messages](#commit-messages)
-- [Join The Project Team](#join-the-project-team)
-
-## I Have a Question
-
-Before you ask a question, it is best to search for existing [Issues](https://github.com/notthebestdev/someoneback/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
-
-If you then still feel the need to ask a question and need clarification, we recommend the following:
-
-- Open an [Issue](https://github.com/notthebestdev/someoneback/issues/new).
-- Provide as much context as you can about what you're running into.
-- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
-
-We will then take care of the issue as soon as possible.
-
-<!--
-You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
-
-Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
-- IRC
-- Slack
-- Gitter
-- Stack Overflow tag
-- Blog
-- FAQ
-- Roadmap
-- E-Mail List
-- Forum
--->
-
-## I Want To Contribute
+- [Quick Start](#quick-start)
+- [Project Structure](#project-structure)
+- [How Commands Work](#how-commands-work)
+- [Adding or Changing a Command](#adding-or-changing-a-command)
+- [Local Quality Checks](#local-quality-checks)
+- [Reporting Bugs](#reporting-bugs)
+- [Security](#security)
+- [Pull Request Checklist](#pull-request-checklist)
 
-> ### Legal Notice <!-- omit in toc -->
->
-> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
+## Quick Start
 
-### Reporting Bugs
+### 1) Prerequisites
 
-<!-- omit in toc -->
+- Node.js (current LTS recommended)
+- npm
+- Wrangler (`npm install -g wrangler`)
 
-#### Before Submitting a Bug Report
+### 2) Install dependencies
 
-A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+```bash
+npm install
+```
 
-- Make sure that you are using the latest version.
-- If you are looking for support, you might want to check [this section](#i-have-a-question).
-- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/notthebestdev/someoneback/issues?q=label%3Abug).
-- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
-- Collect information about the bug:
-  - Stack trace (Traceback)
-  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
-  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
-  - Possibly your input and the output
-  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+### 3) Configure environment variables
 
-<!-- omit in toc -->
+Create a local `.env` file for command registration:
 
-#### How Do I Submit a Good Bug Report?
+```env
+DISCORD_APPLICATION_ID=your_application_id
+DISCORD_TOKEN=your_bot_token
+DISCORD_PUBLIC_KEY=your_public_key
+```
 
-> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <contact@justinn.dev>.
+For deployment, set secrets in Cloudflare:
 
-<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
+```bash
+npx wrangler secret put DISCORD_APPLICATION_ID
+npx wrangler secret put DISCORD_PUBLIC_KEY
+npx wrangler secret put DISCORD_TOKEN
+```
 
-We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+### 4) Register commands and deploy
 
-- Open an [Issue](https://github.com/notthebestdev/someoneback/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
-- Explain the behavior you would expect and the actual behavior.
-- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
-- Provide the information you collected in the previous section.
+```bash
+npm run register
+npm run deploy
+```
 
-Once it's filed:
+## Project Structure
 
-- The project team will label the issue accordingly.
-- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
-- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+- `src/index.ts`: Worker entry point and command mounting.
+- `src/register.ts`: Registers slash commands with Discord.
+- `src/commands/`: Individual command handlers.
+- `src/utils/members.ts`: Discord member fetching/filtering helpers.
+- `src/utils/permissions.ts`: Permission bit checks.
 
-<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
+## How Commands Work
 
-### Suggesting Enhancements
+Current slash commands:
 
-This section guides you through submitting an enhancement suggestion for SomeoneBack, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+- `/someone [ignore-bots]`
+- `/ping`
+- `/help`
 
-<!-- omit in toc -->
+Flow:
 
-#### Before Submitting an Enhancement
+1. Commands are defined for Discord in `src/register.ts`.
+2. Commands are mounted in the Worker app in `src/index.ts`.
+3. Each command handler lives in `src/commands/*.ts` and returns a Discord response with `c.res(...)`.
 
-- Make sure that you are using the latest version.
-- Perform a [search](https://github.com/notthebestdev/someoneback/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
-- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+`/someone` specifics:
 
-<!-- omit in toc -->
+- Requires the **Mention Everyone** permission (checked in `hasRequiredPermissions`).
+- Fetches up to 1000 guild members via Discord REST API.
+- Optionally excludes bots with the `ignore-bots` option.
+- Excludes the command invoker.
+- Chooses a target using `crypto.randomInt`.
 
-#### How Do I Submit a Good Enhancement Suggestion?
+## Adding or Changing a Command
 
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/notthebestdev/someoneback/issues).
+When adding a new command, update all of the following:
 
-- Use a **clear and descriptive title** for the issue to identify the suggestion.
-- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
-- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
-- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
-- **Explain why this enhancement would be useful** to most SomeoneBack users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+1. Add a handler file in `src/commands/`.
+2. Export it from `src/commands/index.ts`.
+3. Mount it in `src/index.ts`.
+4. Register it in `src/register.ts`.
+5. Update help text in `src/commands/help.ts`.
 
-<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
+If your command touches guild members or permissions, prefer reusing logic in `src/utils/members.ts` and `src/utils/permissions.ts` instead of duplicating checks.
 
-### Your First Code Contribution
+## Local Quality Checks
 
-<!-- TODO
-include Setup of env, IDE and typical getting started instructions?
+Run these before opening a PR:
 
--->
+```bash
+npm run lint
+npm run format
+```
 
-### Improving The Documentation
+Useful additional commands:
 
-<!-- TODO
-Updating, improving and correcting the documentation
+- `npm run deploy` to deploy Worker updates.
+- `npm run log` to inspect Worker logs in real time.
+- `npm run cf-typegen` to refresh Cloudflare Worker types.
 
--->
+## Reporting Bugs
 
-## Styleguides
+Please open a GitHub issue and include:
 
-### Commit Messages
+- What happened vs what you expected.
+- Clear reproduction steps.
+- Relevant environment details (OS, Node.js version, npm version).
+- Logs or error messages when available.
 
-<!-- TODO
+## Security
 
--->
+Do not open public issues for vulnerabilities or sensitive data leaks.
 
-## Join The Project Team
+Send security reports to: <contact@justinn.dev>
 
-<!-- TODO -->
+## Pull Request Checklist
 
-<!-- omit in toc -->
+Before submitting a PR:
 
-## Attribution
+- Keep changes focused and minimal.
+- Follow existing TypeScript style and naming.
+- Run lint, tests, and format.
+- Update docs/help text when behavior changes.
+- Add or update tests for logic changes.
+- Include a clear PR description (what changed and why).
 
-This guide is based on the [contributing.md](https://contributing.md/generator)!
+By contributing, you confirm you have rights to your contribution and agree to license it under this project's license.