Contributing Guidelines

We love contributions from the community! This document outlines our contribution process and project standards.

Getting Started

1. Fork the Repository

Fork the GitHub repository to your personal account.

2. Set Up Locally

git clone https://github.com/your-username/mulbs
cd mulbs
npm install

3. Run the Project

npm run dev

Contribution Process

Create an Issue

Create an issue to discuss your proposed changes or bug fixes before starting development.

Branching

Create feature branches from the main branch using descriptive names like feature/documentation-update.

Code Standards

Follow TypeScript best practices and maintain consistent style with existing files.

Submit Pull Request

Create a PR from your branch to main with a clear description of changes.

Code of Conduct

We enforce a Code of Conduct in all community spaces. Our expectation is that participants will show respect and courtesy to other members of the community. If you witness unacceptable behavior, please contact us at team@mulbs.org.

Types of Contributions

✨

Feature Enhancements

Add new features or significant improvements to existing functionality.

🛠

Bug Fixes

Address issues in the codebase or documentation reported by users.

📘

Documentation

Improve tutorial quality, correct technical documentation errors, or translate content.

Submit Your Changes

Before submitting your pull request, be sure that:

  • Your code matches our style guide
  • Automated tests are passing
  • Any new features include documentation
  • Changes follow the contributing process

Need Help?

If you have questions, want to propose a major new feature, or need direction, don't hesitate to reach out.

🤝 Contact Us