Contributing Overview
Welcome to the Noderium contribution guide! We're excited to have you here. This documentation will help you understand our contribution workflow and how to effectively collaborate with the community.
Our Contribution Philosophy
Noderium is an open-source project that values:
- Quality over quantity — We prefer well-thought-out contributions over rushed ones
- Clear communication — Every issue and PR should be self-explanatory
- Community collaboration — We encourage discussion before implementation
- Transparency — Our process is documented and open to all
Contribution Workflow
┌─────────────────────────────────────────────────────────────────┐
│ 1. DISCOVER │
│ Find an issue or identify something to improve │
└─────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ 2. DISCUSS │
│ Open an issue or join a discussion to share your idea │
└─────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ 3. DEVELOP │
│ Fork, branch, code, test, and commit │
└─────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ 4. DELIVER │
│ Open a PR and go through review │
└─────────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ 5. DONE │
│ Merged! Thank you for your contribution │
└─────────────────────────────────────────────────────────────────┘
Quick Links
| I want to... | Go to... |
|---|---|
| Report a bug | Bug Report Template |
| Request a feature | Feature Request Template |
| Propose maintenance | Chore Template |
| Start a research spike | Spike Template |
| Propose refactoring | Refactoring Template |
| Improve documentation | Documentation Template |
| Ask a question | GitHub Discussions |
Before You Start
- Search existing issues — Your idea might already be tracked
- Read the documentation — Familiarize yourself with the project
- Check the roadmap — See what's planned in our Roadmap
- Join the discussion — Complex features benefit from early feedback
Getting Help
- Questions: Use GitHub Discussions
- Bugs: Open an issue using the Bug Report template
- Ideas: Start with a Feature Request or discussion
Ready to contribute? Start by learning about our Issue Templates or jump directly to the Pull Request Guide.