Contributing Guide β
First off, thanks for taking the time to contribute! π
This project is open to contributions of all kinds: code, documentation, examples, bug reports, feature suggestions, and more.
π How to Contribute β
1. Fork the repo β
Click the "Fork" button at the top of the repo, then clone your fork:
bash
git clone https://github.com/monorist/monorise.git
cd monorise2. Create a new branch β
Use a clear and descriptive name:
bash
git checkout -b fix/typo-in-readme3. Make your changes β
Follow existing code style and naming conventions. Run lint and tests before committing.
4. Commit your changes with changesets β
Write clear, concise commit messages:
For changeset, select the impacted packages with ideal semantic versioning.
bash
npm run changeset
git add .
git commit -m "fix: corrected typo in README"5. Push and create a pull request β
bash
git push origin your-branch-nameThen open a pull request from your fork on GitHub. Make sure to:
- Describe what your PR does
- Reference any related issues (
Closes #123) - Include screenshots or examples if applicable
β Guidelines β
- Keep PRs focused and small when possible.
- Use clear and consistent naming.
- Document any new features or changes.
- Write or update tests for any logic changes.
- Follow the Code of Conduct.
π§ͺ Running the Project Locally β
bash
npm install
npm run devTo run tests:
bash
npm testπ€ Need Help? β
Feel free to join our Discord for discussion or create an issue if youβre stuck!
Thanks again! Youβre awesome. π
