Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.13 KB

Contributing to Zettelgarden

Thank you for your interest in contributing to Zettelgarden! We're excited to have you join our community of developers working to make knowledge management more human-centric and effective.

Project Structure

Zettelgarden consists of two main components:

  • zettelkasten-front/: React/TypeScript frontend
  • go-backend/: Go backend server

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/Zettelgarden.git
  3. Create a new branch for your feature: git checkout -b feature/your-feature-name

Development Guidelines

Code Style

  • Frontend: Follow TypeScript best practices and use Prettier for formatting
  • Backend: Follow Go standard formatting (go fmt) and idioms
  • Write meaningful commit messages explaining why changes were made
  • Keep changes focused and atomic

Pull Request Process

  1. Update documentation if you're changing functionality
  2. Ensure your code passes all existing tests
  3. Add tests for new functionality
  4. Update the README.md if needed
  5. Create a Pull Request with a clear description of the changes
  6. Link any related issues

What We're Looking For

We especially welcome contributions in these areas:

  • Improving AI integration while maintaining human agency
  • Enhancing the note-taking and linking experience
  • Performance optimizations
  • Documentation improvements
  • Bug fixes
  • Accessibility improvements

Design Philosophy

When contributing, keep in mind Zettelgarden's core principles:

  1. Human-First: AI should augment human thinking, not replace it
  2. Open and Transparent: Keep the system understandable and modifiable
  3. Privacy-Focused: User data and thoughts belong to the user
  4. Simplicity: Prefer clear, maintainable solutions over complex ones

Getting Help

  • Open an issue for bugs or feature requests
  • Contact the maintainer: [email protected]
  • Check existing issues and pull requests before creating new ones

License

By contributing to Zettelgarden, you agree that your contributions will be licensed under the same terms as the project. See the LICENSE file for details.