-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(root): add project philosophy and core principles
- Loading branch information
1 parent
e89c782
commit ecc8517
Showing
3 changed files
with
117 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! 🙏 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters