File size: 3,033 Bytes
f203641 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# Contributing to OktoEngine
Thank you for your interest in OktoEngine! 🐙
**OktoEngine** is a proprietary CLI engine developed by **OktoSeek AI**. While the source code is not open source, we welcome feedback, bug reports, and feature requests from the community.
---
## How to Contribute
### Reporting Bugs
If you find a bug, please open an issue on GitHub with:
- **Clear description** of the problem
- **Steps to reproduce** the issue
- **Expected vs actual behavior**
- **OktoEngine version:** `okto --version`
- **System information:** `okto doctor` output
- **Debug output** (if applicable): `okto <command> --debug`
**Example:**
```
Bug: Training fails with "Model not found" error
Steps to reproduce:
1. Run `okto init test-project`
2. Edit scripts/train.okt with MODEL { base: "invalid-model" }
3. Run `okto train`
Expected: Clear error message about invalid model
Actual: Generic "Model not found" error
Version: okto 0.1.0
System: Windows 10, GPU: RTX 4070
```
### Feature Requests
Have an idea for a new feature? Open an issue with:
- **Feature description** - What you'd like to see
- **Use case** - Why this feature would be useful
- **Proposed implementation** (optional) - How you think it could work
### Documentation Improvements
Found an error in the documentation? Want to add examples or clarify something?
- Open an issue describing the improvement
- Or submit a pull request with documentation changes (if applicable)
### Examples
Have a great example project? Share it!
- Create an issue with your example
- Include your `train.okt` file
- Describe what your example demonstrates
---
## Code Contributions
**Note:** OktoEngine source code is proprietary. However, we may accept contributions for:
- Documentation improvements
- Example projects
- Test cases
- Bug fixes (in specific cases)
If you're interested in contributing code, please contact us first at **service@oktoseek.com**.
---
## Reporting Security Issues
**Please do not report security vulnerabilities publicly.**
If you discover a security issue, please email **security@oktoseek.com** with:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)
We will respond promptly and work with you to resolve the issue.
---
## Code of Conduct
### Our Standards
- Be respectful and inclusive
- Welcome newcomers and help them learn
- Focus on constructive feedback
- Respect different viewpoints and experiences
### Unacceptable Behavior
- Harassment or discrimination
- Trolling or inflammatory comments
- Personal attacks
- Publishing others' private information
---
## Questions?
- **GitHub Issues:** https://github.com/oktoseek/oktoengine/issues
- **Email:** service@oktoseek.com
- **Website:** https://www.oktoseek.com
---
**OktoEngine** is developed and maintained by **OktoSeek AI**.
Thank you for helping make OktoEngine better! 🚀
|