Contributing

Thank you for your interest in contributing to nuxt-openapi-hyperfetch!

Ways to Contribute

• Report Bugs - Help us identify and fix issues
• Suggest Features - Share ideas for improvements
• Improve Documentation - Fix typos, add examples, clarify content
• Submit Pull Requests - Contribute code

Getting Started

Prerequisites

• Node.js 18+ and npm
• Git
• TypeScript knowledge
• Familiarity with Nuxt 3 and OpenAPI

Development Setup

See Development Guide → for detailed setup instructions.

Quick Start

# Clone repository
git clone https://github.com/dmartindiaz/nuxt-openapi-hyperfetch.git
cd nuxt-openapi-hyperfetch

# Install dependencies
npm install

# Run tests
npm test

# Build project
npm run build

Contribution Workflow

1. Fork the Repository - Create your own fork
2. Create a Branch - git checkout -b feature/my-feature
3. Make Changes - Follow our code style guidelines
4. Write Tests - Add tests for new features
5. Run Tests - Ensure all tests pass
6. Commit Changes - Use conventional commits
7. Push Branch - git push origin feature/my-feature
8. Open Pull Request - Submit PR for review

Guidelines

Code Style

See Code Style Guide → for formatting and conventions.

Key points:

• Use TypeScript
• Follow ESLint rules
• Format with Prettier
• Write clear comments

Testing

See Testing Guide → for testing requirements.

Key points:

• Write unit tests for new features
• Ensure all tests pass
• Maintain code coverage
• Test edge cases

Documentation

See Documentation Guide → for doc standards.

Key points:

• Document new features
• Update API references
• Add usage examples
• Keep docs accurate

Pull Requests

See Pull Request Guidelines → for PR standards.

Key points:

• Clear description
• Link related issues
• Pass CI checks
• Respond to reviews

Code of Conduct

Be respectful and inclusive. We follow the Contributor Covenant Code of Conduct.

Getting Help

• Issues - Check existing issues or create new one
• Discussions - Ask questions in GitHub Discussions
• Discord - Join our community Discord server

Recognition

Contributors are recognized in:

• README.md contributors section
• Release notes
• GitHub contributors page

Resources

• Development Setup →
• Code Style →
• Testing →
• Documentation →
• Pull Requests →
• Release Process →
• Roadmap →

License

By contributing, you agree that your contributions will be licensed under the MIT License.