yosi.ai
Version:
AI-powered code generation tool using Google's Gemini API
73 lines (46 loc) • 1.87 kB
Markdown
# Contributing to yosi.js
Thank you for considering contributing to yosi.js! This document outlines the process for contributing to the project.
## Code of Conduct
By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.
## How Can I Contribute?
### Reporting Bugs
If you find a bug, please create an issue on GitHub with the following information:
- A clear, descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Any relevant logs or screenshots
- Your environment (OS, Node.js version, etc.)
### Suggesting Enhancements
If you have an idea for an enhancement, please create an issue on GitHub with the following information:
- A clear, descriptive title
- A detailed description of the enhancement
- Any relevant examples or mockups
- Why this enhancement would be useful
### Pull Requests
1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Make your changes
4. Run the tests to ensure they pass
5. Submit a pull request
## Development Setup
1. Clone the repository
2. Install dependencies with `npm install`
3. Run tests with `npm test`
## Project Structure
- `src/` - Source code
- `tests/` - Test files
- `examples/` - Example usage
- `docs/` - Documentation
## Testing
Please ensure that your code passes all tests before submitting a pull request. You can run tests with:
```bash
npm test
```
If you're adding new functionality, please also add tests for it.
## Documentation
If you're adding new features or changing existing ones, please update the documentation accordingly.
## Commit Messages
Please use clear, descriptive commit messages that explain the changes you've made.
## License
By contributing to yosi.js, you agree that your contributions will be licensed under the project's MIT license.