Extra community health files

CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of Conduct
+
+Instead of the usual complicated and counterproductive codes of conduct found in many repositories, the only rule with bookbuddies is:
+
+> Be respectful and considerate towards others. Don't be obnoxious, or otherwise disruptive.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to bookbuddies
+
+Thank you for your interest in contributing to bookbuddies! We welcome contributions from everyone. By contributing, you help us improve the project and make it better for all users.
+
+## Non-code contributions
+
+Even without writing code, you can contribute to bookbuddies with other skills you have. You can ask about how you can help in the [Discord server](https://discord.gg/lbry)!
+
+## Getting Started
+
+To get started with contributing to bookbuddies, simply set the repo up as described in the [readme](README.md#setup) and use the `dev:cli` or `dev:gui` commands depending on what you want to do. [Open a pull request](https://github.com/LBRYFoundation/bookbuddies/compare) once you think it's ready to merge.
+
+If you're unfamiliar with the codebase, you can try working on a [good first issue](https://github.com/LBRYFoundation/bookbuddies/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
+
+> [!TIP]
+> Contributing to a codebase you haven't seen before can seem challenging at first, but you might find that it's easier than you think!
+
+## Code Style Guidelines
+
+This project uses Prettier for formatting and ESLint for linting. You can check for (and potentially fix) any issues by running `bun lint`.
+
+The project is set up to help you write code at your pace, so it doesn't include any precommit hooks or run `bun lint` when you use dev commands. As well as making sure you run it before you commit, this is an opportunity to make sure you have ESLint checks and Prettier format-on-save in your editor.
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.
+
+## Contact
+
+If you have any questions or need further assistance, see the [support](SUPPORT.md) info.
+
+We appreciate your contributions!

GOVERNANCE.md

@@ -0,0 +1,7 @@
+# bookbuddies is made by the LBRY Foundation
+
+The LBRY Foundation is a Delaware-based nonprofit dedicated to supporting the LBRY community. bookbuddies was made because content on LBRY often doesn't have many seeds.
+
+All current board members, as well as known active and interested developers, can become maintainers. They review code coming into the project, and are often the first people to provide support.
+
+Anyone can contribute to bookbuddies - it is free and open source software. To get involved, you can join the [Discord server](https://discord.gg/lbry) and start making [contributions](CONTRIBUTING.md).

LICENSE.md

@@ -8,9 +8,7 @@ LBRY Foundation. All rights reserved.
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
-
 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
 3. All advertising materials mentioning features or use of this software should, in good faith, display the following acknowledgment:  
    **"This product includes software developed by the LBRY Foundation and its contributors."**
 

README.md

@@ -1,3 +1,5 @@
+![CI](https://github.com/lbryfoundation/bookbuddies/actions/workflows/ci.yaml/badge.svg?branch=main&event=push)
+
 # bookbuddies
 
 A project by the LBRY Foundation to allow you to seed relevant LBRY content, so the network becomes more decentralised!
@@ -9,27 +11,25 @@ Download the correct binary for your system from here, and run it.
 > [!IMPORTANT]
 > If you see an 'Illegal Instruction' error, this likely means your CPU does not support modern instructions. If this happens, you should use a slower but compatible `baseline` build from the [Releases](https://github.com/lbryfoundation/bookbuddies/releases) page.
 
-| Platform | Architecture | UI       | Link  |
-|----------|--------------|----------|-------|
-| Windows  | x64          | GUI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/windows-x64-gui.exe) |
-| Windows  | x64          | CLI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/windows-x64-cli.exe) |
-| macOS    | x64          | GUI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-x64-gui) |
-| macOS    | x64          | CLI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-x64-cli) |
-| macOS    | arm64        | GUI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-arm64-gui) |
-| macOS    | arm64        | CLI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-arm64-cli) |
-| Linux    | x64          | GUI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-x64-gui) |
-| Linux    | x64          | CLI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-x64-cli) |
-| Linux    | arm64        | GUI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-arm64-gui) |
-| Linux    | arm64        | CLI      | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-arm64-cli) |
+| Platform | Architecture | UI  | Link                                                                                            |
+| -------- | ------------ | --- | ----------------------------------------------------------------------------------------------- |
+| Windows  | x64          | GUI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/windows-x64-gui.exe) |
+| Windows  | x64          | CLI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/windows-x64-cli.exe) |
+| macOS    | x64          | GUI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-x64-gui)       |
+| macOS    | x64          | CLI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-x64-cli)       |
+| macOS    | arm64        | GUI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-arm64-gui)     |
+| macOS    | arm64        | CLI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/macos-arm64-cli)     |
+| Linux    | x64          | GUI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-x64-gui)       |
+| Linux    | x64          | CLI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-x64-cli)       |
+| Linux    | arm64        | GUI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-arm64-gui)     |
+| Linux    | arm64        | CLI | [Download](https://github.com/lbryfoundation/bookbuddies/releases/download/linux-arm64-cli)     |
 
 ### Should I choose GUI or CLI?
 
 The GUI (graphical user interface) version functions like a standard desktop app, with visual elements to click on with the mouse.
 
 The CLI (command-line interface) version runs in the terminal.
 
-
-
 The GUI is best if you're running bookbuddies on your personal computer, since it can run in the background easily. If you want to run it on a server instead, and you are familiar with applications in the console, the CLI may be a better choice.
 
 ## Setup
@@ -40,17 +40,17 @@ You'll only need to do this if you're planning to [build](#building) or [contrib
 > Make sure you have [Git](https://git-scm.com/) and [Bun](https://bun.sh/) installed first.
 
 1. Clone the repository.
-    ```sh
-    git clone https://github.com/lbryfoundation/bookbuddies.git
-    ```
+   ```sh
+   git clone https://github.com/lbryfoundation/bookbuddies.git
+   ```
 2. Switch to the newly made `bookbuddies` folder.
-    ```sh
-    cd bookbuddies
-    ```
+   ```sh
+   cd bookbuddies
+   ```
 3. Install all dependencies.
-    ```sh
-    bun i
-    ```
+   ```sh
+   bun i
+   ```
 
 <details>
 <summary>All together (copy and paste)</summary>
@@ -60,6 +60,7 @@ git clone https://github.com/lbryfoundation/bookbuddies.git
 cd bookbuddies
 bun i
 ```
+
 </details>
 
 ## Building
@@ -77,8 +78,8 @@ Windows ARM devices are currently unsupported.
 
 ## Contributing
 
-Pull requests are welcome! Simply make sure you run `bun lint` with updated packages before you submit one to prevent any delays.
+Contributions, including non-code ones, are welcome! See more in the [contributing](CONTRIBUTING.md) file.
 
 ## Security
 
-If you spot a vulnerability, you can disclose it safely at [`[email protected]`](mailto:[email protected]?subject=Responsible%20disclosure%20for%20vulnerability%20in%20bookbuddies).
+If you spot a vulnerability, you can disclose it safely in accordance with the [security](SECURITY.md) file.

SECURITY.md

@@ -0,0 +1,13 @@
+# The LBRY Foundation takes security issues seriously
+
+If you find a vulnerability while looking through bookbuddies, please disclose this immediately to [[email protected]](mailto:[email protected]?subject=Responsible%20disclosure%20for%20vulnerability%20in%20bookbuddies).
+
+We kindly request that you follow responsible disclosure practices when you report an issue to us. This means:
+
+- Provide detailed information about the vulnerability, including steps to reproduce and any potential impact.
+- Allow us a reasonable amount of time to investigate and address the issue before disclosing it publicly.
+- Do not exploit the vulnerability or share it with others until it has been resolved.
+
+If your vulnerability report leads to a fix, we will credit you for discovering it.
+
+The LBRY Foundation will never pay for a vulnerability disclosure prior to knowing what it is. We may award funds for a security disclosure, depending on severity, on a case-by-case basis.

SUPPORT.md

@@ -0,0 +1,15 @@
+# Support
+
+> [!TIP]
+> Before you go into support channels, see if your question is answered by the [documentation](https://bookbuddies.lbry.org/docs)! Doing this can help save you time.
+
+To get support with this project, you can ask:
+
+- In the [#bookbuddies channel in the Discord server](https://discord.gg/lbry) **(recommended!)**
+- Through the [discussions tab](https://github.com/LBRYFoundation/bookbuddies/discussions)
+- In the [Telegram group](https://t.me/lbryofficial)
+- By emailing [[email protected]](mailto:[email protected]?subject=Issues%20with%20bookbuddies&body=Hello!%0D%0A%0D%0AI'm%20trying%20to%20use%20the%20%5BCLI%2FGUI%5D%20version%20of%20bookbuddies%2C%20but%20%5Bissue%20here%5D.%0D%0A%0D%0AYou%20can%20reproduce%20this%20issue%20by%3A%0D%0A%0D%0A%5Blist%20the%20steps%20we%20need%20to%20take%20to%20cause%20the%20same%20problem%20you%20found%5D%0D%0A%0D%0AI%20expected%20this%20to%20%5Bsomething%5D%2C%20but%20it%20%5Bsomething%20else%5D%20instead.%0D%0A%0D%0AThanks%2C%0D%0A%5Bname%5D) (not recommended - getting a response can take a long time, and you're less likely to get a good answer)
+
+If you're experiencing an issue with the software, and you know the problem is with bookbuddies and not your setup, you can also [open an issue](https://github.com/LBRYFoundation/bookbuddies/issues) after making sure one doesn't already exist.
+
+Getting support might seem daunting, but we're friendly people! In some cases, it might even help get a bug fixed.

package.json

@@ -16,7 +16,7 @@
 		"typescript-eslint": "^8.2.0"
 	},
 	"scripts": {
-		"lint": "bun eslint --fix && bun prettier . -w && bun tsc --noEmit",
+		"lint": "bun update && bun eslint --fix && bun prettier . -w && bun tsc --noEmit",
 		"start:cli": "NODE_ENV=production bun run src/cli/cli.ts",
 		"start:gui": "NODE_ENV=production bun run src/gui/gui.ts",
 		"dev:cli": "NODE_ENV=development bun run src/cli/cli.ts",