Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 3.58 KB

Contributing to micropython_i2c_lcd

Hi there! 👋

Thank you for considering contributing to the micropython_i2c_lcd library. I'm thrilled to have you here and excited to see how your ideas can make this library even better. Below are some guidelines to help you get started.

How to Contribute

No contribution is too small. If you have an idea, bug fix, question, or want to share your usecases, I would be honored to hear about it!

Opening an Issue

If you have an initial idea, question, bug report, or any other feedback, please open an issue! This is a great way to discuss ideas and get feedback before diving into code changes. Here's how you can do it:

  1. Go to the Issues page.
  2. Click on the "New Issue" button.
  3. Provide a clear and descriptive title and description of the issue. Screenshots, images, videos, code snippets, etc. are encouraged.

Submitting a Pull Request (PR)

PRs are welcome from anyone and everyone, whether you're a seasoned developer or just just trying things out. Here’s how you can submit a PR:

  1. Fork the Repository: Click on the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: 
    git clone https://github.com/<username>/micropython_i2c_lcd.git
cd micropython_i2c_lcd
  3. Create a Branch: Create a new branch for your changes. 
    git checkout -b my-feature-branch
  4. Make Your Changes: Implement your changes in the new branch.
  5. Commit Your Changes: Write a clear commit message. 
    git commit -am 'Add new feature'
  6. Push to Your Fork: 
    git push origin my-feature-branch
  7. Open a Pull Request: Go back to the upstream repository (https://github.com/thomascountz/micropython_i2c_lcd) and click on the "New Pull Request" button. Then, select your branch and provide a detailed description of your changes.

Need Help?

If you have an idea but aren't sure where to start with implementing it, I'd love to help you! Open an issue explaining your idea or problem, and we'll collaborate together to bring it to life. This could be something about the library or even something specific to your project. Either way, let's work together.

What to Contribute

  • New Features: Have an idea for a new feature? Open an issue to discuss it or directly submit a PR.
  • Bug Fixes: Found a bug? Open an issue or submit a PR with the fix.
  • Documentation: Improvements to documentation are always welcome.
  • Examples: If you want to share examples on how you're using the library, please share them!

Code of Conduct

Everyone to is welcome and safe here. If you ever feel unsafe, harassed, discouraged, attacked, or unwelcome because of someone else's actions, that's not okay. I have no tolerance for behavior that intends to makes others feel this way, and those responsible will be removed from this space. Regardless of intent, I will always do my best to recognize, support, and address these situations when they arise. I may also actively encourage you to recognize when your actions might be contributing to a negative environment in a good faith effort to prevent misunderstandings from escalating. With that said, I have taken on this role so that you don't have to worry. Please make yourself comfortable in knowing that you and your contributions are welcome here!

Thank You!

Your contributions make a big difference, and I am truly honored by your time and effort. Together, we can make micropython_i2c_lcd an even more awesome library!

Happy coding! 🚀

Thomas