Contributing to MagmaStream

Welcome! Whether you're fixing a typo, writing a guide, or improving the core library — here's how to get started.

---

Pick a Repo

Area	Repo	Notes
Core Library	magmastream	PRs must target the dev branch.
Documentation	magmastream_documentation	Fork → edit .mdx → PR.
Example Bot	magmastream_basics_bot	Choose your branch: typescript or javascript.
Advanced Guides	magmastream_guides	Add or improve real-world examples.

---

Docs Contributions

1. Fork magmastream_documentation and create a branch.
2. Edit or add files inside docs/. To add a new page, copy any existing .mdx file and follow its structure.
3. Optionally preview locally:

   npm install && npm start

4. Commit, push, and open a pull request.

---

Code Contributions

1. Fork magmastream and branch off dev.
2. Make your changes inside src/.
3. Run the test suite:

   npm install && npm run ci

4. Commit, push, and open a pull request targeting the dev branch.

---

PR Guidelines

• Keep PRs focused and small.
• Follow Conventional Commits.
• Write a clear PR description.
• Test your changes where applicable.

---

Questions?

Join our Discord — we're happy to help.

Thanks for contributing to MagmaStream.