|
| 1 | + |
| 2 | +# Contributing |
| 3 | + |
| 4 | +Thanks for your interest in contributing! |
| 5 | +This is a volunteer-driven hobby project and we welcome contributions. |
| 6 | + |
| 7 | +## Ways to Contribute |
| 8 | + |
| 9 | +- Bug fixes |
| 10 | +- New features |
| 11 | +- Documentation improvements |
| 12 | +- Bug reports |
| 13 | + |
| 14 | +## Developing |
| 15 | + |
| 16 | +See [developing.md](./developing.md) |
| 17 | + |
| 18 | +## Guidelines for Pull Requests |
| 19 | + |
| 20 | +- Keep PRs focused on a single change |
| 21 | +- Write clear commit messages |
| 22 | +- Add tests for new functionality, or to cover against regressions |
| 23 | +- Remember to update documentation |
| 24 | + |
| 25 | +## Filing Issues |
| 26 | + |
| 27 | +Before creating an issue: |
| 28 | +- Search existing issues to avoid duplicates |
| 29 | +- Use a clear, descriptive title |
| 30 | + |
| 31 | +For bug reports, include: |
| 32 | +- Steps to reproduce |
| 33 | +- Expected vs actual behavior |
| 34 | +- Your environment (OS, version, etc.) |
| 35 | + |
| 36 | +For feature requests: |
| 37 | +- Describe the problem you're trying to solve / your usecase |
| 38 | +- Explain your proposed solution |
| 39 | + |
| 40 | +## AI/LLM Generated Code |
| 41 | + |
| 42 | +We accept the use of AI tools to assist with development, |
| 43 | +but all code must meet the same quality standards regardless of how it was created: |
| 44 | + |
| 45 | +- You must review and **understand** all code |
| 46 | +- Code must be tested and verified to work correctly |
| 47 | +- Follow the project's existing patterns and conventions |
| 48 | +- AI-generated code is not an excuse for lower quality |
| 49 | +- Code must be minimal to solve the problem at hand |
| 50 | +- Code must be simple, readable and easy to maintain |
| 51 | + |
| 52 | +You are responsible for any code you submit, regardless of its origin. |
| 53 | +Pull Requests that do not demonstrate sufficient attention to quality, |
| 54 | +will be rejected. |
| 55 | + |
| 56 | +## Code of Conduct |
| 57 | + |
| 58 | +Be respectful and constructive. |
| 59 | +We're all here to learn and build something useful together. |
| 60 | + |
| 61 | +## Questions? |
| 62 | + |
| 63 | +Ask in [discussions](https://github.com/emlearn/emlearn-micropython/discussions). |
0 commit comments