Contributing Guide¶
Thank you for your interest in contributing!
Getting Started¶
Fork the repository on GitHub
Clone your fork:
git clone https://github.com/<your-username>/jpyc-tipjar-widget.git
Set up your development environment
Create a feature branch:
git checkout -b feature/my-feature
Development Workflow¶
Branch Naming¶
Prefix |
Use |
|---|---|
|
New features |
|
Bug fixes |
|
Code refactoring |
|
Documentation |
|
Test additions |
|
Configuration, dependencies |
Commit Messages¶
Use emoji prefixes for commit messages:
Emoji |
Use |
|---|---|
✨ |
New feature |
🐛 |
Bug fix |
♻️ |
Refactoring |
📝 |
Documentation |
🔧 |
Configuration change |
✅ |
Test addition/fix |
Format: <emoji> <verb> <concise description>
Submitting Changes¶
Ensure all tests pass
Ensure code style checks pass
Build the project
Push your branch and create a Pull Request
PR Guidelines¶
Keep PRs focused on a single feature or fix
Write a clear description of what changed and why
Reference related issues if applicable