Skip to content

README.md

Latest commit

 

History

History
84 lines (53 loc) · 2.17 KB

README.md

File metadata and controls

84 lines (53 loc) · 2.17 KB

Contributing to bspwmctl

Thank you for your interest in contributing! 🎉

Quick Links

Ways to Contribute

🐛 Report Bugs

Found a bug? Open a bug report.

💡 Suggest Features

Have an idea? Request a feature.

📖 Improve Documentation

Documentation can always be better! Feel free to:

  • Fix typos or unclear instructions
  • Add examples or screenshots
  • Write new guides

Submit PRs to the docs repository.

💻 Contribute Code

Ready to code? Check out:

  1. Good first issues
  2. Read the Contributing Guide
  3. Fork, code, and open a PR!

🎨 Share Themes

Created a cool theme? We'd love to see it! (theme repository coming soon)

Development Setup

# Fork and clone
git clone https://github.com/YOUR_USERNAME/bspwmctl.git
cd bspwmctl

# Create a branch
git checkout -b feature/your-feature-name

# Make your changes
# ...

# Test your changes
./bspwmctl check

# Commit and push
git add .
git commit -m "feat: add awesome feature"
git push origin feature/your-feature-name

Then open a pull request on GitHub!

Code Style

  • Use 4 spaces for indentation (not tabs)
  • Keep lines under 100 characters when possible
  • Add comments for complex logic
  • Follow existing code patterns

Getting Help

Need help contributing?

Thank You! ❤️

Every contribution, no matter how small, helps make bspwmctl better for everyone.