Skip to content

README.md

Latest commit

 

History

History
171 lines (119 loc) · 3.6 KB

README.md

File metadata and controls

171 lines (119 loc) · 3.6 KB

Contributing to Lockdn

Welcome to the Lockdn contributor community! This guide helps you get started contributing to Lockdn, whether you're fixing bugs, adding features, or improving documentation.

Quick Links

Document Purpose
CONTRIBUTING.md How to contribute (process and guidelines)
Development Guide Local setup and development workflow
Architecture System architecture and design patterns
AGENTS.md Guidelines for AI coding assistants
Contributor Agreement Legal terms for contributions

Why Contribute?

Lockdn is built by students, for students. Every contribution helps students worldwide:

  • Bug fixes improve reliability for daily study use
  • Features expand what students can accomplish
  • Documentation helps new users and contributors
  • Translations make Lockdn accessible globally
  • Testing ensures quality across platforms

Getting Started

1. Set Up Your Development Environment

Follow the Development Guide to:

  • Clone the repository
  • Install dependencies
  • Run the development server
  • Run tests

2. Find Something to Work On

Good first issues:

  • Look for issues labeled good first issue
  • Documentation improvements
  • UI polish and accessibility fixes
  • Test coverage improvements

Bigger projects:

  • Check issues labeled help wanted
  • Review the roadmap in GitHub Discussions
  • Propose your own feature (open an issue first)

3. Understand the Codebase

  • Read the Architecture Guide
  • Explore src/ to understand the structure
  • Review existing patterns in similar features
  • Ask questions in GitHub Discussions

4. Make Your Contribution

  • Create a feature branch
  • Write code following the style guide
  • Add tests for new functionality
  • Update documentation as needed
  • Submit a pull request

Contribution Types

Code Contributions

  • Bug fixes
  • New features
  • Performance improvements
  • Accessibility enhancements
  • Refactoring

Documentation

  • User guide improvements
  • Developer documentation
  • Code comments
  • README updates
  • Translations

Testing

  • Unit tests
  • Integration tests
  • E2E tests
  • Manual testing and bug reports

Design

  • UI/UX improvements
  • Accessibility audits
  • User research

Community Guidelines

Be Respectful

  • Treat all contributors with respect
  • Welcome newcomers
  • Provide constructive feedback
  • Assume good intentions

Be Collaborative

  • Discuss significant changes before implementing
  • Share knowledge and help others
  • Credit others' contributions
  • Accept feedback gracefully

Be Patient

  • Maintainers are volunteers
  • Reviews take time
  • Some decisions require discussion
  • Not every contribution will be merged

Getting Help

GitHub Discussions

Best for:

  • Questions about the codebase
  • Design discussions
  • Feature proposals
  • General help

GitHub Issues

Best for:

  • Bug reports
  • Feature requests with clear scope
  • Documentation problems

Pull Request Comments

Best for:

  • Specific code questions
  • Implementation guidance
  • Review feedback

Recognition

Contributors are recognized in:

  • Release notes
  • Contributors list
  • Git history

Your contributions help students succeed in their studies. Thank you for being part of Lockdn!

Next Steps

  1. Read the Contributor Agreement
  2. Set up your environment with the Development Guide
  3. Find an issue to work on
  4. Make your first contribution!