🤝 Contributing to Code-y

We welcome and appreciate contributions from the community! Whether it's code, bug reports, feature ideas, or documentation improvements, your help makes Code-y better for everyone.

Ways to Contribute

  • Code Contributions:
    • Fixing bugs and submitting pull requests.
    • Implementing new features or enhancements.
    • Improving the performance or architecture of the tool.
    • Adding support for new languages or frameworks (if applicable in the future).
  • Bug Reports: If you find a bug, please create a detailed issue on our GitHub repository. Include steps to reproduce, expected behavior, actual behavior, and your environment details (OS, Node.js version, Code-y version).
  • Feature Requests: Have a great idea for Code-y? Open an issue to discuss it. Provide a clear description of the feature and why it would be valuable.
  • Documentation Improvements:
    • Clarifying existing documentation.
    • Adding examples or use cases.
    • Correcting typos or grammatical errors.
    • Translating documentation (if applicable).
  • AI Model Integrations: If you have experience with specific AI models (especially local ones via Ollama) that could enhance Code-y's capabilities, we'd love to hear your suggestions or see PoCs.
  • Community Support: Helping other users by answering questions in forums, Discord (if one exists), or on GitHub discussions.

General Guidelines for Code Contributions

  1. Fork the Repository: Start by forking the main Code-y repository on GitHub.
  2. Create a Branch: Create a new branch for your feature or bug fix (e.g., `feature/new-parser` or `fix/cli-crash`).
  3. Develop: Make your changes. Adhere to the existing code style and conventions.
  4. Test: Ensure your changes don't break existing functionality. Add tests for new features if applicable.
  5. Commit: Write clear, concise commit messages.
  6. Push: Push your changes to your forked repository.
  7. Open a Pull Request (PR): Submit a PR to the main Code-y repository. Provide a detailed description of your changes, why they were made, and any relevant issue numbers.

Please ensure your PRs are focused. If you have multiple unrelated changes, submit them as separate PRs. The project maintainers will review your PR, provide feedback, and merge it if everything looks good.

Thank you for considering contributing to Code-y!