|
| 1 | +# 🤝 Contributing Guidelines |
| 2 | + |
| 3 | +First of all, **thank you** for taking the time to contribute to our project! Your help is greatly appreciated. |
| 4 | +Whether it's a small typo fix, a new feature, or reporting a bug — every contribution counts! |
| 5 | + |
| 6 | +## 🧭 Getting Started |
| 7 | + |
| 8 | +Before you start contributing, please: |
| 9 | + |
| 10 | +1. **Read the documentation** to understand the project structure and goals. |
| 11 | +2. **Search existing issues** to avoid duplicates. |
| 12 | +3. **Check the [Security Policy](SECURITY.md)** if your contribution relates to a vulnerability. |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## 📂 How to Contribute |
| 17 | + |
| 18 | +### 🐛 Reporting Bugs |
| 19 | + |
| 20 | +- Use the **"Bug Report" issue template**. |
| 21 | +- Provide clear, step-by-step instructions to reproduce the problem. |
| 22 | +- Include screenshots or logs if relevant. |
| 23 | + |
| 24 | +### ✨ Suggesting Features |
| 25 | + |
| 26 | +- Use the **"Feature Request" template**. |
| 27 | +- Describe the feature and its use case. |
| 28 | +- Explain how it fits the purpose of the project. |
| 29 | + |
| 30 | +### 🛠️ Submitting Code |
| 31 | + |
| 32 | +1. Fork the repository. |
| 33 | +2. Create a new branch: `git checkout -b your-feature-name`. |
| 34 | +3. Commit your changes: `git commit -m "Add feature: ..."` |
| 35 | +4. Push to your fork: `git push origin your-feature-name`. |
| 36 | +5. Open a **Pull Request** and describe your changes. |
| 37 | + |
| 38 | +💡 Don’t hesitate to ask for feedback or a code review! |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## 🧹 Code Style & Standards |
| 43 | + |
| 44 | +- Follow the existing code style. |
| 45 | +- Write clear, descriptive commit messages. |
| 46 | +- Use English for all code comments and documentation. |
| 47 | +- Run tests before submitting your PR (if applicable). |
| 48 | + |
| 49 | +--- |
| 50 | + |
| 51 | +## 👥 Code of Conduct |
| 52 | + |
| 53 | +Please be respectful and welcoming to other contributors. |
| 54 | +We follow a [Code of Conduct](CODE_OF_CONDUCT.md) to keep the community safe and positive. |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## 💬 Need Help? |
| 59 | + |
| 60 | +If you're stuck, feel free to: |
| 61 | + |
| 62 | +- Open a GitHub Discussion |
| 63 | +- Join our [Discord server](https://discord.gg/89ENkYSCWE) |
| 64 | +- Contact the maintainers via email: contact.formula1france@gmail.com |
0 commit comments