MikuMikuBeam/CONTRIBUTING.md
James 5235f0cc49
Create CONTRIBUTING.md
I just added this since i see most people are confused and this should tell them before starting any issues...
2025-01-24 01:26:08 -08:00

1.6 KiB

Contributing to MikuMikuBeam!

Welcome! before you start makeing ANY issues. (or requests) Did you?

  • Have carefully READ the entirely Setup and Installation?
  • open the terminal or command prompt in your Miku folder? (psst, clone or download the repo first and then enter it)
  • Have Node.js (v14 or above) and npm installed onto your pc (or server?) first?
  • run git pull # to be in the latest version.
  • Make proxies.txt amd uas.txt if it doesn't exist in the data folder. (if it does exist then ignore this part.)
  • run npm install in the terminal (im assuming you are useing ubuntu, or windows terminal....)
  • and then run npm run dev to start the server!
  • then go to localhost:5173 and it should look like this! (Im useing Dark reader but you will see the same thing. The "active bots" number will be diffrent for each user) Dark mode Last of all, please check for existing issues before reporting any issues.

🐛 Reporting Issues

If you find a bug or have a feature request, please open an issue and include:

  • A clear and descriptive title.
  • Steps to reproduce (if applicable).
  • Expected vs. actual behavior.
  • Relevant screenshots or logs.

🔧 Submitting a Pull Request (PR)

  1. Fork the repository and create a new branch:
    git checkout -b feature/your-feature