73 lines
2.2 KiB
Markdown
73 lines
2.2 KiB
Markdown
# Contributing to LetterSpace
|
|
|
|
Thank you for your interest in contributing to LetterSpace! This document provides guidelines and instructions for contributing.
|
|
|
|
## Code of Conduct
|
|
|
|
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/letterspace.git`
|
|
3. Add the upstream repository: `git remote add upstream https://github.com/ORIGINAL-OWNER/letterspace.git`
|
|
4. Create a branch for your work: `git checkout -b feature/your-feature-name`
|
|
|
|
## Development Setup
|
|
|
|
1. Install dependencies: `pnpm install`
|
|
2. Start the development server: `pnpm dev`
|
|
|
|
## Making Changes
|
|
|
|
1. Make your changes in your feature branch
|
|
2. Write or update tests as needed
|
|
3. Ensure your code follows the project's coding style
|
|
4. Run tests to make sure everything passes: `pnpm test`
|
|
5. Commit your changes with a descriptive commit message
|
|
|
|
## Commit Message Guidelines
|
|
|
|
We follow conventional commits format:
|
|
|
|
- `feat:` - A new feature
|
|
- `fix:` - A bug fix
|
|
- `docs:` - Documentation changes
|
|
- `style:` - Code style changes (formatting, etc.)
|
|
- `refactor:` - Code changes that neither fix bugs nor add features
|
|
- `perf:` - Performance improvements
|
|
- `test:` - Adding or fixing tests
|
|
- `chore:` - Changes to the build process or auxiliary tools
|
|
|
|
Example: `feat: add email template customization`
|
|
|
|
## Submitting a Pull Request
|
|
|
|
1. Push your changes to your fork: `git push origin feature/your-feature-name`
|
|
2. Open a pull request against the main repository
|
|
3. Fill in the pull request template
|
|
4. Wait for maintainers to review your changes
|
|
|
|
## Reporting Bugs
|
|
|
|
When reporting bugs:
|
|
|
|
- Use a clear and descriptive title
|
|
- Describe the exact steps to reproduce the issue
|
|
- Include any relevant logs or error messages
|
|
- Specify which version you're using
|
|
|
|
## Requesting Features
|
|
|
|
When requesting features:
|
|
|
|
- Explain the problem the feature would solve
|
|
- Describe how users would use the feature
|
|
- Consider how it fits with existing functionality
|
|
|
|
## Questions?
|
|
|
|
If you have any questions, feel free to open an issue or reach out to the maintainers.
|
|
|
|
Thank you for contributing to LetterSpace!
|