Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dicko2 authored Dec 21, 2023
1 parent 2fe54fd commit 55e9761
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@


# Contributing to ApplicationInsights for KafkaFlow

🚀 Welcome to the fast-paced world of contributing to ApplicationInsights for KafkaFlow! We're excited to have you aboard our coding spaceship. Here's how you can strap in and help us navigate the cosmos of code.

## Ways to Contribute

1. **Bug Bounty Hunting:** Spot a bug? Don’t just swat it—report it! Open an issue in our GitHub repo. Be as detailed as possible, like a detective describing the scene of a very nerdy crime.

2. **Idea Factory:** Got a brainwave for a killer feature or an improvement? We want to hear it! Tag your issue as a feature request and prepare to be showered with virtual high-fives.

3. **Code Contributions:**
- **Fork It Over:** Fork our repo faster than you can say "git clone"!
- **Branch Out:** Create a branch. Naming it something cool or funny is encouraged but not mandatory (sadly).
- **Code Like the Wind:** Make your changes. Remember, we’re all about that fast, modern development style. If you’re not living on the edge, you’re taking up too much space!
- **Test, Please:** Add some tests. If they pass, do a little dance. If not, no tears—debugging is half the fun!
- **Documentation, Schmocumentation:** If your changes are more than a sneeze in the codebase, update the docs. Or at least add some comments that future-you won’t hate past-you for.
- **Pull Request Party:** Submit that PR! We use squash merge, so don’t worry if your commit messages read like a weird, cryptic novel.

4. **Review Rodeo:** Dive into open pull requests. Your comments can be helpful, witty, or both – as long as they are constructive.

## Guidelines

- **Code of Conduct – It’s a Thing:** Seriously, read it. It’s like the rulebook for how not to be a jerk.
- **Quality is Key:** We like our code like we like our jokes – clean and well-executed.
- **Testing is Caring:** Tests are the seatbelts of coding. Buckle up!
- **Commit Messages – Short and Sweet:** Since we squash merge, your poetic commit soliloquies matter less, but clear titles and descriptions in your PR are the real MVPs.
- **Keep Up or Catch Up:** Regularly sync your fork. It's like keeping your fridge stocked; nobody likes an empty fridge.
- **Have Fun:** Remember, coding is a journey, not a destination. Enjoy the ride!

## Pull Request Protocol

1. **Avoid Duplication:** Check for open issues and PRs. Duplicating efforts is like bringing chips to a party that already has chips. Good, but unnecessary.
2. **Be Clear, Be Bright, Be Brief:** Describe your changes in the PR like you’re explaining it to a sleep-deprived developer at 3 AM.
3. **Feedback Fiesta:** Respond to feedback on your PR like you’re at a party. Be polite, engaging, and maybe bring some virtual snacks.

## Thank You!

Your contributions help keep this project more lively than a caffeinated squirrel! So, thanks for being part of this zany, code-loving crew.

0 comments on commit 55e9761

Please sign in to comment.