# Contributing to NeuG

We welcome contributions from the community! 🎉

## Getting Started

1. **Fork** the repository and **clone** your fork
2. **Set up** the development environment (see [Development Guide](./doc/source/development/dev_guide.md))
3. **Make your changes** and add tests
4. **Run tests** and formatters
5. **Submit** a pull request

## Quick Development Setup

```bash
# Using Docker (recommended)
docker pull neug-registry.cn-hongkong.cr.aliyuncs.com/neug/neug-dev:v0.1.3
docker run -it --name neug-dev neug-registry.cn-hongkong.cr.aliyuncs.com/neug/neug-dev:v0.1.3 bash
source ~/.neug_env && make python-dev
```

## Before You Submit

**Run these commands:**
```bash
# Format your code
make neug_clformat  # C++
cd tools/python_bind && python3 -m black . && python3 -m isort .  # Python

# Run tests
cd tools/python_bind && python3 -m pytest tests/
```

## Code Guidelines

- **C++**: Follow [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
- **Python**: Use [black](https://black.readthedocs.io/en/stable/) formatter
- **Tests**: Write tests for new features and bug fixes
- **Documentation**: Update docs for API changes in `doc/source/`

## Pull Request Guidelines

- Keep PRs focused and reasonably sized
- Include tests and documentation updates
- Ensure all CI checks pass
- Reference relevant issues in your PR description

## Reporting Issues

When reporting bugs, please include:
- Platform (Linux/macOS/Windows)
- Python version and NeuG version
- Minimal code example to reproduce the issue

## Questions?

- 📖 Check the [Development Guide](./doc/source/development/dev_guide.md)
- 🐛 [Open an issue](https://github.com/alibaba/neug/issues) for bugs or questions
- 💬 Start a discussion for feature ideas

## Code of Conduct

This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and inclusive.

## Generative AI Policy
Please do not submit pull requests generated by AI (LLMs). Reviewing such PRs put a considerable burden on the maintainers.

---

Thank you for making NeuG better!