Contributing to Makinari

Join our open source community and help build the future of AI-powered growth platforms.

Bug Reports

Help us identify and fix issues

  • •Check existing issues first
  • •Use the bug report template
  • •Provide clear reproduction steps
  • •Include environment details

Feature Requests

Suggest new features and improvements

  • •Check existing feature requests
  • •Describe the use case clearly
  • •Explain the expected behavior
  • •Consider implementation complexity

Code Contributions

Submit code improvements and fixes

  • •Fork the repository
  • •Create a feature branch
  • •Follow coding standards
  • •Submit a pull request

Documentation

Improve documentation and guides

  • •Identify unclear sections
  • •Write clear explanations
  • •Add code examples
  • •Update outdated information

Getting Started

Quick Start Guide

1

Fork the Repository

Create your own copy of the project

2

Clone Your Fork

Download the code to your local machine

3

Create a Branch

Start working on your feature or fix

4

Submit a PR

Create a pull request for review

Development Setup

bash
 1 2 3 4 5 6 7 8 9101112131415
# Fork and clone the repository
git clone https://github.com/Uncodier/market-fit.git
cd market-fit
 
# Install dependencies
npm install
 
# Create environment file
cp .env.example .env.local
 
# Start development server
npm run dev
 
# Run tests
npm test

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors. By participating in this project, you agree to abide by our Code of Conduct.

We Encourage

  • ✓Respectful and constructive feedback
  • ✓Collaborative problem-solving
  • ✓Diverse perspectives and experiences
  • ✓Professional and courteous communication

We Prohibit

  • ✗Harassment or discrimination
  • ✗Inappropriate or offensive language
  • ✗Personal attacks or trolling
  • ✗Spam or off-topic discussions

License: GNU Affero General Public License v3.0 (AGPL-3.0)

A copyleft license that requires derivative works to be open source. This license ensures that all improvements and modifications to Makinari remain open source and benefit the entire community.

What You Can Do

✓
Commercial Use
You can use this software commercially
✓
Modification
You can modify the code
✓
Distribution
You can distribute the software
✓
Patent Use
Patent rights are granted to users

What You Cannot Do

✗
Proprietary Derivatives
You cannot create closed-source derivatives
✗
Network Use without Source
If used over a network, source code must be available

Why AGPL-3.0?

  • •Prevents direct competition using our code
  • •Ensures all improvements are shared with the community
  • •Protects network-based applications like Makinari
  • •Maintains open source ecosystem integrity

Join Our Community

Connect with other contributors, get help, and stay updated on the latest developments.

GitHubContact Us