From d0fa16da20ce019bbe3f1a6e3c46e3301575d803 Mon Sep 17 00:00:00 2001 From: Hiroaki Mitsuyoshi Date: Mon, 15 Sep 2025 03:31:47 +0900 Subject: [PATCH] docs: add CONTRIBUTING.md --- CONTRIBUTING.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5a738f9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# Contributing to envui + +Thank you for your interest in contributing to envui. All contributions are welcome. + +## How to Contribute + +For significant changes, please open an issue first to discuss your proposed changes. This helps ensure alignment with project goals and prevents duplicate efforts. + +## Development Process + +### Getting Started + +1. Fork the repository +2. Clone your fork: `git clone https://github.com/your-username/envui.git` +3. Create a feature branch from `develop`: `git checkout -b feature/your-feature develop` +4. Make your changes +5. Push to your fork: `git push origin feature/your-feature` +6. Open a Pull Request against the `develop` branch + +### Commit Messages + +Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification: + +### Pull Requests + +Keep pull requests small and focused. Each PR should represent a single logical change. Split large changes into multiple PRs when possible. + +## Development Setup + +### Prerequisites + +- Node.js 18 or higher +- pnpm package manager + +### Installation + +```bash +pnpm install +``` + +### Running Tests + +```bash +pnpm test +``` + +### Building + +```bash +pnpm build +``` + +### Linting and Formatting + +```bash +pnpm lint +pnpm lint:fix +pnpm format +pnpm typecheck +``` + +## Questions and Support + +If you have questions or need clarification, please open an issue. We aim to respond promptly to all inquiries. + +## License + +By contributing to envui, you agree that your contributions will be licensed under the MIT License.