| # Contributing to OktoScript | |
| Thank you for your interest in contributing to OktoScript! 🐙 | |
| **OktoScript** is a proprietary domain-specific programming language developed and owned by **OktoSeek AI**. We welcome contributions from the community for documentation, examples, bug reports, and feature suggestions! | |
| **Important:** OktoScript is a proprietary language. While we welcome contributions, you may not create derivative languages, tools, or interpreters based on OktoScript. See [OKTOSCRIPT_LICENSE.md](./OKTOSCRIPT_LICENSE.md) for complete license terms. | |
| ## How to Contribute | |
| ### Reporting Issues | |
| If you find a bug or have a feature request, please open an issue on GitHub with: | |
| - Clear description of the problem or feature | |
| - Steps to reproduce (for bugs) | |
| - Expected vs actual behavior | |
| - OktoScript version (if applicable) | |
| ### Submitting Changes | |
| 1. **Fork the repository** | |
| 2. **Create a feature branch** (`git checkout -b feature/amazing-feature`) | |
| 3. **Make your changes** following the code style | |
| 4. **Test your changes** thoroughly | |
| 5. **Commit your changes** (`git commit -m 'Add amazing feature'`) | |
| 6. **Push to the branch** (`git push origin feature/amazing-feature`) | |
| 7. **Open a Pull Request** | |
| ### Code Style | |
| - Follow the existing OktoScript grammar specification | |
| - Keep examples in English | |
| - Document new features in `docs/grammar.md` | |
| - Update README.md if adding major features | |
| ### Adding Examples | |
| When adding new examples: | |
| - Place them in `examples/your-example-name/` | |
| - Follow the standard folder structure | |
| - Include complete `train.okt` file | |
| - Add sample datasets | |
| - Update `examples/README.md` | |
| ### Documentation | |
| - Keep grammar documentation up to date | |
| - Add examples for new features | |
| - Update README.md for major changes | |
| - Always mention **OktoSeek AI** as the developer/maintainer | |
| ## Questions? | |
| Feel free to open an issue for any questions about contributing! | |
| --- | |
| **OktoScript** is developed and maintained by **OktoSeek AI**. | |
| Thank you for helping make OktoScript better! 🚀 | |