Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (73 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

98 lines (73 loc) · 3.43 KB
Raw

Katkıda Bulunma Rehberi / Contributing Guide

🇹🇷 Türkçe

Hoş Geldiniz!

Fluent Dynamics projesine katkıda bulunmak istediğiniz için teşekkür ederiz. Bu belge, katkıda bulunma sürecini herkes için mümkün olduğunca kolay ve verimli hale getirmek için rehberlik sağlar.

Nasıl Katkıda Bulunabilirsiniz?

Hata Raporlama

  • Bir hata bulduğunuzda, lütfen GitHub üzerinde bir "issue" açın.
  • Hatayı net bir şekilde tanımlayın ve mümkünse yeniden oluşturma adımlarını ekleyin.
  • Eğer mümkünse, sistem bilgilerinizi (işletim sistemi, tarayıcı, vs.) ekleyin.

Özellik Önerme

  • Yeni bir özellik önermek için, GitHub üzerinde bir "issue" açın.
  • Özelliği detaylı bir şekilde açıklayın ve neden faydalı olacağını belirtin.

Pull Request Süreci

  1. Repoyu fork edin ve geliştirmeyi yapacağınız branch'i oluşturun.
  2. Kodunuzu yazın ve gerekli testleri ekleyin.
  3. Kodunuzun mevcut stil kılavuzlarına uyduğundan emin olun.
  4. Pull request açın ve değişiklikleri açıklayan bir açıklama ekleyin.
  5. İnceleme sürecinde istenen değişiklikleri yapın.

Kod Standartları

  • Temiz ve okunabilir kod yazın.
  • Kodunuzu yeterince belgelendirin.
  • Mevcut kod stiline uyun.

Davranış Kuralları

Bu proje için Contributor Covenant davranış kurallarını benimsiyoruz. Katkıda bulunan herkesin bu kurallara uyması beklenir.

🇬🇧 English

Welcome!

Thank you for considering contributing to the Fluent Dynamics project. This document provides guidelines to make the contribution process easy and effective for everyone involved.

How Can You Contribute?

Reporting Bugs

  • If you find a bug, please open an issue on GitHub.
  • Clearly describe the bug and include steps to reproduce if possible.
  • Include your system information (operating system, browser, etc.) if relevant.

Suggesting Features

  • To suggest a new feature, open an issue on GitHub.
  • Describe the feature in detail and why it would be beneficial.

Pull Request Process

  1. Fork the repository and create your branch from where you want to base your work.
  2. Write your code and add necessary tests.
  3. Ensure your code adheres to the existing style guidelines.
  4. Open a pull request with a descriptive title and explanation of changes.
  5. Address any requested changes during the review process.

Code Standards

  • Write clean and readable code.
  • Document your code adequately.
  • Follow the existing code style.

Code of Conduct

We adopt the Contributor Covenant Code of Conduct for this project. All contributors are expected to adhere to this code.

Development Setup

  1. Fork the repository
  2. Clone your fork locally 
    git clone https://github.com/yourusername/fluent-dynamics.git
cd fluent-dynamics
  3. Set up the development environment according to the README instructions
  4. Create a new branch for your feature or bugfix 
    git checkout -b feature/your-feature-name
  5. Make your changes
  6. Test your changes
  7. Commit your changes 
    git commit -m "Add feature: your feature description"
  8. Push to your fork 
    git push origin feature/your-feature-name
  9. Create a Pull Request from your fork to the main repository

License

By contributing, you agree that your contributions will be licensed under the project's license.