Skip to content

Commit

Permalink
feat(root): add project philosophy and core principles
Browse files Browse the repository at this point in the history
  • Loading branch information
abretonc7s committed Nov 1, 2024
1 parent e89c782 commit ecc8517
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 2 deletions.
57 changes: 55 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,56 @@
# Contributing
# Contributing to @siteed/universe

TODO
First off, thank you for considering contributing to @siteed/universe! This project exists to help developers build better applications, and your help makes a difference.

## Table of Contents
- [Code of Conduct](#code-of-conduct)
- [Development Process](#development-process)
- [Project Structure](#project-structure)
- [Setting Up Development Environment](#setting-up-development-environment)
- [Making Contributions](#making-contributions)
- [Coding Standards](#coding-standards)
- [Testing Guidelines](#testing-guidelines)
- [Documentation](#documentation)

## Code of Conduct

This project follows a Code of Conduct that all contributors are expected to adhere to. Please read [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) before contributing.

## Development Process

1. **Fork & Clone**
```bash
git clone https://github.com/yourusername/universe.git
cd universe
pnpm install
```

2. **Branch**
- Feature branches: `feature/your-feature-name`
- Bug fixes: `fix/issue-description`
- Documentation: `docs/what-you-are-documenting`

3. **Develop**
- Make your changes
- Follow the coding standards
- Add tests
- Update documentation

4. **Commit**
We use conventional commits. Format your commit messages as:
```
type(scope): description
[optional body]
[optional footer]
```
Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`

5. **Submit PR**
- Ensure all tests pass
- Fill out the PR template
- Link related issues


Thank you for contributing! 🙏
54 changes: 54 additions & 0 deletions PHILOSOPHY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Philosophy Behind @siteed/universe

## Vision
As a builder and hacker at heart, I believe in creating tools that make development more efficient and enjoyable. This monorepo represents my commitment to open-source development and serves as the foundation for all my projects, from experimental prototypes to production applications.

## Core Principles

### 1. Build to Learn, Share to Grow
- Every package started as a learning tool
- Documentation and examples are first-class citizens
- Share knowledge through practical, reusable implementations

### 2. Cross-Platform by Default
- Mobile-first but platform-agnostic
- Consistent experience across iOS, Android, and Web
- Leverage Expo for rapid prototyping and deployment

### 3. Developer Experience First
- Type-safe by default with TypeScript
- Comprehensive documentation and examples
- Automated workflows for common tasks
- Strong testing and validation

### 4. Modular and Maintainable
- Each package solves one problem well
- Clear boundaries between packages
- Consistent patterns across all packages

## Current Focus
This monorepo contains my essential developer toolkit:

- **@siteed/design-system**: A cross-platform UI component library
- **@siteed/react-native-logger**: Advanced logging for mobile apps
- **@siteed/publisher**: Streamlined monorepo release management
- **@siteed/gitguard**: AI-powered commit quality tools

## Goals

### Short-term
1. Improve documentation and examples
2. Add more test coverage
3. Create video tutorials and blog posts
4. Build a community of contributors

### Long-term
1. Expand to hardware/software integration tools
2. Add AI-powered development utilities
3. Create comprehensive project templates
4. Build a ecosystem of compatible tools

## Contributing
This project is my way of giving back to the developer community. While these tools are primarily built for my own needs, I welcome contributions that align with the core principles above.

See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Welcome to `@siteed/universe`, a comprehensive monorepo containing a design system and various packages for mobile and web development. This project aims to provide reusable components and utilities to streamline the development process for mobile and web applications.

## Why This Exists
1. **Accountability**: Public development forces better documentation and structure
2. **Knowledge Sharing**: Help others learn from real-world implementations
3. **Community**: Build a community of developers who share similar development philosophies
4. **Experimentation**: A platform to try new ideas and get feedback

[Read more about the philosophy behind this project](./PHILOSOPHY.md)

## Features

- **[Design System](./packages/design-system/README.md):** A cohesive set of design elements and components to ensure a consistent look and feel across your applications.
Expand Down

0 comments on commit ecc8517

Please sign in to comment.