Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Future features and improvements will be listed here

### Changed
- Ongoing updates and modifications

### Fixed
- Bug fixes and corrections

---

## How to Update This Changelog

When making changes, add an entry under `[Unreleased]` in the appropriate category:

- **Added** – new features
- **Changed** – changes to existing functionality
- **Deprecated** – soon-to-be removed features
- **Removed** – removed features
- **Fixed** – bug fixes
- **Security** – vulnerability fixes

When releasing, change `[Unreleased]` to the version number and date,
then add a new empty `[Unreleased]` section at the top.

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
Comment on lines +35 to +36

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Official community health files like CHANGELOG.md represent the project as a whole and typically do not include personal contribution footers. Additionally, the [Unreleased] header at the top of the file should have a corresponding link reference at the bottom of the file to compare changes. Let's remove the footer and add the link reference placeholder.

Suggested change
---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
[unreleased]: https://github.com/mlc-ai/mlc-llm/compare/v0.1.0...HEAD

67 changes: 67 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.
Comment on lines +53 to +54

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The Code of Conduct needs a specific, private contact method (such as an email address or a private form) for reporting violations. Without this, contributors have no safe way to report harassment or other issues.

Suggested change
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.
reported to the community leaders at [INSERT EMAIL/CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All complaints will be reviewed and investigated promptly and fairly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
Comment on lines +66 to +67

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Official community health files like CODE_OF_CONDUCT.md represent the project as a whole and typically do not include personal contribution footers. Git history is the standard way to attribute contributions.

54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing

Thank you for your interest in contributing! We appreciate all contributions,
from bug reports to feature requests and code improvements.

## How to Contribute

### Reporting Bugs
- Check existing [issues](../../issues) first to avoid duplicates

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using a root-relative link /issues is more robust than ../../issues because it will resolve correctly regardless of where the CONTRIBUTING.md file is located (e.g., if it is moved to .github/ or docs/ in the future).

Suggested change
- Check existing [issues](../../issues) first to avoid duplicates
- Check existing [issues](/issues) first to avoid duplicates

- Open a new issue with a clear title and description
- Include steps to reproduce, expected vs actual behavior, and environment details

### Suggesting Features
- Open an issue with the `enhancement` label

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

On GitHub, general contributors do not have permissions to add labels (like enhancement) to issues they create. It is better to instruct them to open a feature request or use a feature request template if available.

Suggested change
- Open an issue with the `enhancement` label
- Open a feature request issue

- Describe the feature and explain why it would be valuable

### Submitting Code

1. **Fork** this repository
2. **Create a branch** from `main`:
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes** and add tests if applicable
4. **Commit** with a clear message:
```bash
git commit -m "feat: add your feature description"
```
5. **Push** to your fork and open a **Pull Request**

## Guidelines

- Follow the existing code style and conventions
- Keep PRs focused on a single concern
- Write clear commit messages
- Update documentation when changing behavior
- Be respectful and constructive in all interactions (see [Code of Conduct](CODE_OF_CONDUCT.md))

## Development Setup

```bash
# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME
Comment on lines +43 to +44

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since this is the mlc-llm repository, we should replace the placeholder REPO_NAME with the actual repository name mlc-llm to make the setup commands directly copy-pasteable for contributors.

Suggested change
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME
git clone https://github.com/YOUR_USERNAME/mlc-llm.git
cd mlc-llm


# Install dependencies (see README for details)
```

## Questions?

Open an issue or start a discussion — we're happy to help!

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
Comment on lines +53 to +54

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Official community health files like CONTRIBUTING.md represent the project as a whole and typically do not include personal contribution footers. Git history is the standard way to attribute contributions.

12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,15 @@ The underlying techniques of MLC LLM include:
}
```
</details>


## Contributing

We welcome contributions of all kinds! Please read [CONTRIBUTING.md](CONTRIBUTING.md)
for guidelines on how to report bugs, suggest features, and submit pull requests.

By participating in this project, you agree to follow our
[Code of Conduct](CODE_OF_CONDUCT.md).

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*