Charm - Contributing

✨ First off, thank you for your support in our mission to make terminals glamorous! ✨

Welcome to Contributing

We’re thrilled you want to help make Charmbracelet’s projects even more glamorous! ✨ Our mission is to create delightful terminal experiences, and your contributions—whether bug fixes, features, or refactors—are key to that. As a small team, we may take time to review, but we deeply value every contribution.

We prioritize bug fixes but welcome all ideas! Be patient as we balance reviews with other priorities.

How to Contribute

Here’s how to contribute to Charmbracelet projects effectively:

Propose new features by opening a GitHub Discussion in the "Ideas" category. Describe your idea clearly to get feedback from maintainers and the community before coding.

Report or Fix Bugs

For bugs, open an issue with steps to reproduce or submit a pull request (PR) with a fix. Include tests or a minimal example showing the issue and solution.

Submit a Pull Request

Create a PR with clear changes, ensuring it passes all tests and CI. Include a description of the changes and their impact. Mark as "Ready for Review" only when complete, and note any issues you’re facing in the PR description.

Key Guidelines

Follow these best practices for smooth contributions:

Start with a GitHub Discussion to propose features. Once approved, submit a PR with clear documentation, tests, and alignment with project goals.

Provide clear steps to reproduce the bug, ideally with tests or a minimal example. This helps maintainers verify the issue and confirm the fix quickly.

Ensure PRs pass all examples, tests, and CI checks. Include a concise description of changes and their benefits. For refactors, explain the improvements. Mark as "Ready for Review" only when complete.

Check similar features in other Charm projects for consistency. Use conventional commits (e.g., feat: add spinner, fix: resolve crash) for clear release notes.

License Agreement

When contributing, you must agree that you’ve authored 100% of the content or have rights to it, and that it may be provided under the project’s MIT license.

What’s Next?

Keep the glamour flowing by joining our community:

GitHub Discussions: Share ideas, ask questions, or propose features.
Open Issues: Find bugs or tasks to contribute to.
Charm Repositories: Explore other projects like Bubbles or Lip Gloss.
Bubble Tea Docs: Deepen your knowledge to contribute effectively.

We can’t wait to see your contributions! ૮ ˶ᵔ ᵕ ᵔ˶ ა

Contributing