CONTRIBUTING.md

Contributing to OneByJorah projects

Thanks for taking the time to contribute! Every island in the JorahOne archipelago gets stronger with community help.

How to contribute

1. Open an issue first for bugs, features, or large refactors so we can align on direction.
2. Fork the repo and create a feature branch (git checkout -b feature/short-name).
3. Keep changes focused — one concern per pull request.
4. Write clear commit messages in the imperative: Add SNMP trap handler, not Added handler.
5. Update docs if your change affects usage, configuration, or architecture.
6. Test your change locally before opening a PR.

Pull request checklist

• Branch is up to date with the default branch.
• README/screenshots are updated if the UI or install steps changed.
• No secrets, credentials, or private IPs are committed.
• License header is preserved on new source files (MIT).

Code style

• Python: PEP 8, type hints where helpful.
• JavaScript/TypeScript: consistent formatting, const/let, async/await over callbacks.
• Shell/PowerShell: defensive execution, clear parameter comments.

Questions?

Open a Discussion or reach out at info@jorahone.com.