|
| 1 | +# Contributing to the Excel-Style Color Picker for WinForms 🎨 |
| 2 | + |
| 3 | +🎉 First off, thank you for considering contributing! We're thrilled you're here and interested in making this project even better. Your contributions are what make the open-source community such an amazing place. |
| 4 | + |
| 5 | +This document provides a set of guidelines for contributing to this project. These are mostly guidelines, not strict rules. Use your best judgment, and feel free to propose changes to this document in a pull request. |
| 6 | + |
| 7 | +## 🤝 Code of Conduct |
| 8 | + |
| 9 | +This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior. |
| 10 | + |
| 11 | +## 🤔 How Can I Contribute? |
| 12 | + |
| 13 | +There are many ways to contribute, and not all of them involve writing code. We value all forms of contribution! |
| 14 | + |
| 15 | +- **🐛 Reporting Bugs**: If you find a bug, please let us know! |
| 16 | +- **💡 Suggesting Enhancements**: Have a great idea for a new feature or an improvement to an existing one? We'd love to hear it. |
| 17 | +- **👨💻 Writing Code**: Help fix bugs or add new features by submitting a pull request. |
| 18 | +- **📖 Improving Documentation**: If you see a typo, a confusing sentence, or a section that could be clearer in our `README.md` or other documentation, feel free to submit a fix. |
| 19 | + |
| 20 | +### 🐛 Reporting Bugs |
| 21 | + |
| 22 | +Before creating a bug report, please **check the existing issues** to see if someone has already reported the problem. |
| 23 | + |
| 24 | +When you create a bug report, please include as many details as possible: |
| 25 | + |
| 26 | +1. **A clear and descriptive title** for the issue. |
| 27 | +2. **Steps to reproduce the bug**. A minimal, reproducible example is a huge help! |
| 28 | +3. **What you expected to happen** versus **what actually happened**. |
| 29 | +4. **Screenshots or GIFs** are incredibly helpful for UI-related bugs. |
| 30 | +5. **Your environment details**, such as your .NET version and Windows version. |
| 31 | + |
| 32 | +### 💡 Suggesting Enhancements |
| 33 | + |
| 34 | +We're always looking for ideas to improve this component. To suggest an enhancement: |
| 35 | + |
| 36 | +1. **Start by creating a new issue**. |
| 37 | +2. **Provide a clear and descriptive title**. |
| 38 | +3. **Explain your idea in detail**. Why would this be a useful addition? What problem does it solve? |
| 39 | +4. **Include sketches, mockups, or examples** if possible. |
| 40 | + |
| 41 | +## 👨💻 Your First Code Contribution (Pull Requests) |
| 42 | + |
| 43 | +Ready to write some code? Great! Here’s how to set up for a pull request. |
| 44 | + |
| 45 | +### Development Setup |
| 46 | + |
| 47 | +1. **Fork** the repository on GitHub. |
| 48 | +2. **Clone** your fork to your local machine: |
| 49 | + ```bash |
| 50 | + git clone https://github.com/samialtas/CSharpColorPicker.git |
| 51 | + ``` |
| 52 | +3. **Open the project** in Visual Studio. |
| 53 | +4. **Create a new branch** for your changes. Please use a descriptive branch name: |
| 54 | + ```bash |
| 55 | + git checkout -b feature/new-feature |
| 56 | + # or |
| 57 | + git checkout -b fix/bug-that-i-fixed |
| 58 | + ``` |
| 59 | + |
| 60 | +### Pull Request Process |
| 61 | + |
| 62 | +1. **Make your changes** in your new branch. Please follow the style guide below. |
| 63 | +2. **Ensure the project builds** without any errors. |
| 64 | +3. **Test your changes** to make sure they work as expected and don't introduce new bugs. |
| 65 | +4. **Update the `README.md`** or other documentation if your changes affect it (e.g., adding a new property or feature). |
| 66 | +5. **Commit your changes** with a clear and concise commit message. |
| 67 | + ```bash |
| 68 | + git commit -m "feat: Add a new property to the control" |
| 69 | + ``` |
| 70 | +6. **Push your branch** to your fork on GitHub: |
| 71 | + ```bash |
| 72 | + git push origin feature/my-new-feature |
| 73 | + ``` |
| 74 | +7. **Open a Pull Request** (PR) from your fork's branch to the `main` branch of the original repository. |
| 75 | +8. **Fill out the PR template**. Provide a clear title and a detailed description of your changes. If your PR fixes an existing issue, be sure to link it using keywords like `Closes #123`. |
| 76 | + |
| 77 | +### 🎨 Style Guide |
| 78 | + |
| 79 | +To keep the codebase consistent and easy to read, please follow these guidelines: |
| 80 | + |
| 81 | +- **Match the existing coding style.** Look at the existing code to get a feel for the patterns used. |
| 82 | +- Follow standard C#/.NET naming conventions (e.g., `PascalCase` for methods, properties, and classes; `camelCase` for local variables). |
| 83 | +- Add comments to explain complex or non-obvious parts of your code. |
| 84 | +- Use meaningful names for variables, methods, and classes. |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +Thank you again for your interest in contributing. We can't wait to see what you create! ✨ |
0 commit comments