Skip to content
Open
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
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to Knowte

First off, thank you for considering contributing to Knowte! 🚀

Knowte is an offline-first desktop application designed to transform lecture audio into structured and accessible learning material. Contributions from developers, designers, writers, and open-source enthusiasts help improve the project and make learning more accessible for everyone.

We welcome contributions of all sizes, including:
- Bug fixes
- Documentation improvements
- Feature enhancements
- UI/UX improvements
- Performance optimizations
- Testing and code quality improvements

---

# Table of Contents

- [Getting Started](#getting-started)
- [Fork and Clone the Repository](#fork-and-clone-the-repository)
- [Project Setup](#project-setup)
- [Running the Application](#running-the-application)
- [Branch Naming Convention](#branch-naming-convention)
- [Commit Message Guidelines](#commit-message-guidelines)
- [Coding Standards](#coding-standards)
- [Pull Request Process](#pull-request-process)
- [Reporting Issues](#reporting-issues)
- [Beginner Contribution Workflow](#beginner-contribution-workflow)
- [Best Practices](#best-practices)
- [Community Guidelines](#community-guidelines)

---

# Getting Started

Before contributing, please ensure that you:

- Read the project README carefully
- Check existing issues and pull requests
- Discuss major changes before implementation
- Follow the coding and contribution standards

We encourage contributors to start with beginner-friendly issues before moving to advanced tasks.

---

# Fork and Clone the Repository

## 1. Fork the Repository

Click the **Fork** button on the top-right corner of the repository page.

## 2. Clone Your Fork

```bash
git clone https://github.com/your-username/knowte.git
cd knowte