Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Contribution.md #598

Closed
wants to merge 1 commit into from
Closed
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
58 changes: 58 additions & 0 deletions Contribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing to web-llm 🎉

Thank you for considering contributing to the **web-llm** project! We appreciate your interest and support in improving the project. 🙌

## How to Contribute 🤝

There are several ways you can contribute to the **web-llm** project:

### Reporting Issues 🐞

If you encounter any bugs or have feature requests, please follow these steps:

1. **Check Existing Issues**: Before submitting a new issue, please check the existing issues to see if your concern has already been reported. 🔍
2. **Create a New Issue**: If your issue is not listed, please create a new issue using the following template:
- **Title**: A concise title for your issue.
- **Description**: Describe the issue in detail, including steps to reproduce, expected behavior, and actual behavior.
- **Environment**: Include information about your environment (e.g., OS, browser, etc.).

### Feature Requests ✨

We welcome feature requests! To submit a feature request:

1. **Check Existing Requests**: Ensure your request hasn’t been made before. 📝
2. **Open a New Issue**: Describe the feature you’d like to see, why it’s important, and how it could enhance the project.

### Contributing Code 💻

If you want to contribute code to the **web-llm** project, follow these steps:

1. **Fork the Repository**: Click the "Fork" button at the top-right corner of the repository page to create your copy. 🍴
2. **Clone Your Fork**: Clone your forked repository to your local machine:
```bash
git clone https://github.com/YOUR_USERNAME/web-llm.git

```

3. Create a New Branch: Create a new branch for your change
```bash
git checkout -b your-feature-branch

4. Make Your Changes: Implement your changes in the code.

5. Commit Your Changes: Commit your changes with a clear and descriptive commit message:
```bash
git commit -m "Brief description of your changes"
6. Push Your Changes: Push your changes to your forked repository
```bash
git push origin your-feature-branch

7. Create a Pull Request: Go to the original repository and click on the "Pull Requests" tab. Click on "New Pull Request" and select your branch to create a pull request. Provide a description of your changes and why they are needed

## Code of Conduct📜
By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations for behavior

## Questions? ❓
If you have any questions about contributing, feel free to open an issue or reach out to the maintainers. We’re here to help! 😊

Thank you for your contributions! 🎊
Loading