Contributing to NoLimitConnect¶
Thank you for your interest in helping NoLimitConnect.
This project currently uses a lightweight workflow that works well for a single maintainer and external contributors.
Workflow¶
- Contributors use fork + pull request.
- Maintainer reviews and merges pull requests to main.
- No direct write access is needed to contribute.
Steps¶
- Fork the repository on GitHub.
- Clone your fork locally.
- Create a branch for your change.
- Commit and push your branch to your fork.
- Open a pull request to nolimitconnect/NoLimitConnect main.
Local docs preview¶
pip install mkdocs-material
mkdocs serve
Default URL:
- http://127.0.0.1:8000/
Contribution priorities¶
- Documentation under docs/
- Small reproducible bug fixes
- Build and packaging improvements
- Test and CI reliability
PR quality checklist¶
- Keep PRs focused.
- Explain what changed and why.
- Include validation steps.
- Link related issues when applicable.
Security¶
For security issues, follow SECURITY.md and avoid public disclosure in issues.
Also see¶
- Root contribution guide in CONTRIBUTING.md
- Issue tracker: https://github.com/nolimitconnect/NoLimitConnect/issues