|
| 1 | +# Contributing to HonoX |
| 2 | + |
| 3 | +This document outlines guidelines for contributing to HonoX. Please take a moment to review it before submitting your contributions. |
| 4 | + |
| 5 | +## How Can I Contribute? |
| 6 | + |
| 7 | +### Reporting Bugs |
| 8 | + |
| 9 | +If you find a bug, please open an issue on our [GitHub Issues](https://github.com/honojs/honox/issues) page. |
| 10 | + |
| 11 | +When reporting a bug, please include: |
| 12 | + |
| 13 | +- A clear and concise description of the bug. |
| 14 | +- Steps to reproduce the behavior. |
| 15 | +- Expected behavior. |
| 16 | +- Screenshots or GIFs if applicable. |
| 17 | +- Your environment details (OS, dependency versions, etc.). |
| 18 | + |
| 19 | +### Suggesting Enhancements |
| 20 | + |
| 21 | +Got an idea for a new feature or improvement? We'd love to hear it! Please open an issue on our [GitHub Issues](https://github.com/honojs/honox/issues) page. |
| 22 | + |
| 23 | +When suggesting an enhancement, please include: |
| 24 | + |
| 25 | +- A clear and concise description of the enhancement. |
| 26 | +- Why you think it would be valuable to the project. |
| 27 | +- Any potential alternatives or considerations. |
| 28 | + |
| 29 | +### Pull Request Guidelines |
| 30 | + |
| 31 | +1. Fork the repository and create your branch from `main`. |
| 32 | +2. Make your changes. |
| 33 | +3. Ensure your code adheres to our style guides (see [Style guides](#style-guides)). |
| 34 | +4. Write clear, concise commit messages (see [Git Commit Messages](#git-commit-messages)). |
| 35 | +5. Test your changes thoroughly. |
| 36 | +6. Update documentation if your changes require it. |
| 37 | +7. Open a pull request to the `main` branch. |
| 38 | + |
| 39 | +In your pull request, please: |
| 40 | + |
| 41 | +- Reference the issue you are addressing (e.g., `Fixes #123`). |
| 42 | +- Provide a clear summary of your changes. |
| 43 | +- Include any relevant screenshots or GIFs. |
| 44 | + |
| 45 | +## Development Setup |
| 46 | + |
| 47 | +To get started with development, follow these steps: |
| 48 | + |
| 49 | +Clone the repository: |
| 50 | + |
| 51 | +```bash |
| 52 | +git clone https://github.com/[your-username]/honox.git |
| 53 | +cd honox |
| 54 | +``` |
| 55 | + |
| 56 | +Install dependencies: |
| 57 | + |
| 58 | +```bash |
| 59 | +bun install |
| 60 | +``` |
| 61 | + |
| 62 | +We are using bun and strongly recommend it. |
| 63 | + |
| 64 | +## Style guides |
| 65 | + |
| 66 | +### Git Commit Messages |
| 67 | + |
| 68 | +We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for our commit messages. This helps us generate consistent and readable commit histories. |
| 69 | + |
| 70 | +Examples: |
| 71 | + |
| 72 | +- `feat: Add new user authentication` |
| 73 | +- `fix: Correct typo in README` |
| 74 | +- `docs: Update installation guide` |
| 75 | +- `refactor: Improve error handling logic` |
| 76 | + |
| 77 | +### Code Style |
| 78 | + |
| 79 | +We use [Eslint](https://eslint.org/) and [Prettier](https://prettier.io/) for code formatting. Please ensure your code is formatted correctly before submitting a pull request. |
| 80 | + |
| 81 | +You can lint and format your code using: |
| 82 | + |
| 83 | +```bash |
| 84 | +bun run lint:fix |
| 85 | +bun run format:fix |
| 86 | +``` |
0 commit comments