Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (54 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

73 lines (54 loc) · 2.05 KB

Contributing to Thunder

Thank you for your interest in contributing to Thunder! 🎉 We welcome contributions of all kinds—from bug reports and documentation improvements to feature development and optimizations.

How to Contribute

1️⃣ Fork and Clone the Repository

  1. Click the Fork button on GitHub to create your own copy of the repository.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/Thunder.git
cd Thunder
  3. Add the upstream repository: 
    git remote add upstream https://github.com/Raezil/Thunder.git

2️⃣ Create a Feature Branch

Before making changes, create a new branch:

git checkout -b feature/your-feature-name

3️⃣ Make Your Changes

  • Follow Go best practices and project coding standards.
  • Write tests for new features or bug fixes.
  • Run tests before submitting: 
    go test ./...

4️⃣ Commit and Push Changes

  1. Stage your changes: 
    git add .
  2. Write a clear commit message: 
    git commit -m "Add feature: description"
  3. Push your changes: 
    git push origin feature/your-feature-name

5️⃣ Submit a Pull Request (PR)

  1. Open a pull request from your feature branch to main.
  2. Provide a clear description of your changes.
  3. Address any feedback from maintainers.

Reporting Issues

If you encounter a bug or have a feature request:

  • Check if the issue already exists in GitHub Issues.
  • If not, create a new issue with a descriptive title and detailed steps to reproduce (if applicable).

Community Engagement

Join the discussion and contribute in various ways:

  • GitHub Discussions: Ask questions, propose features, and get support.
  • Discord: Join our community for real-time collaboration.

Code of Conduct

By participating in this project, you agree to follow our Code of Conduct.

We appreciate your contributions and look forward to collaborating with you! 🚀