Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.58 KB

Contributing to 🦁Chimera🐍!

First and foremost, a huge thank you for considering contributing to Chimera! Whether you're fixing a bug, proposing a new feature, or pondering becoming a maintainer, your support is what keeps this project alive and kicking. 🫶

About 📄

We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Therefore we've created this document to provide a set of best practices for your contributions!

How to Contribute

Reporting a bug 🐛

Spot a bug? We use Github issues for tracking. Reporting is simple:

  1. Check if the bug exists: Browse existing issues to avoid duplicates
  2. Report: Open a new issue, providing a clear title and description. Screenshots and code snippets are highly encouraged!

Discuss the State of the Code 💬

Engaging in discussions about the current state of the code, potential improvements, and innovative ideas are highly encouraged!

Want to start a discussion? Create a new discussion, choosing the category you want to discuss!

Here's some of our Best Practices for Discussion:

  • Be Respectful: Respect others' opinions and be open to feedback. We strive for a welcoming and inclusive environment.
  • Stay On Topic: Keep discussions focused on the technical aspects and how changes can improve the project.
  • Provide Context: When suggesting changes or highlighting issues, provide as much context as possible. Links to documentation, previous discussions, or examples can be incredibly helpful.
  • Ask Questions: Don’t hesitate to ask for clarification if something isn’t clear. Our community is here to help each other.

Code Contribution 🤝

Before you dive in, here are some key points to ensure your contributions make a smooth landing:

  • Coding Style: We use Prettier for formatting. Ensure your code align with our style guide for consistency.
  • SCSS over CSS: Make your styling changes in .scss files, not .css. Remember to compile & build your SCSS changes with sass sass/main.scss css/chimera.css.
  • Pull Requests: Ready to submit your code? Open a pull request with a clear list of what you've done. The more detailed, the better!

Proposing Features 💡

Got an idea for a new feature? We're all ears!! Here's how to propose it:

  1. Check Existing Discussions: Browse through our Discussion board and Issues to see if your idea has been previously suggested or discussed.
  2. Start with an Issue: Open a new issue to discuss your idea. This allows for feedback and collaboration from the community.
  3. Outline the Feature: Provide a detailed explanation of the feature and its benefits.

Becoming a Maintainer 🧑‍🔧

Interested in taking a more active role in Chimera? Maintainers are crucial to our project's health and growth. Reach out to us with your contributions and interest!

Any contributions you make will be under the Apache license 2.0

In short, when you submit code changes, your submissions are understood to be under the same Apache license 2.0 license that covers the project. Feel free to contact the maintainers if that's a concern.