Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
87 lines (58 loc) · 2.5 KB

CONTRIBUTING.MD

File metadata and controls

87 lines (58 loc) · 2.5 KB

🤝 Contributing to FundwaveSL

Thank you for your interest in contributing to FundwaveSL! 🎉 We welcome contributions from everyone—whether it's fixing bugs, adding new features, improving documentation, or suggesting ideas.

This guide outlines how you can contribute effectively.

🚀 Getting Started

  1. Fork & Clone the Repository

    • Fork the repository on GitHub.
    • Clone it to your local machine:
    git clone https://github.com/Walon-Foundation/fundwave.git
cd fundwave

  2. Create a New Branch

    • Follow the naming convention: git checkout -b feature/your-feature-name

🛠 Making Changes

Implement Your Changes

  • Make the necessary code changes in your branch.
  • Write or update tests as needed.
  • Ensure your code follows the project's coding style and conventions.

Keep Changes Focused

  • Each pull request (PR) should focus on a single issue or feature.
  • Keep functions small and maintainable.

📤 Submitting Your Changes

  1. Push your branch to GitHub

    git push origin feature/your-feature-name

  2. Open a Pull Request (PR)

    • Go to the main repository on GitHub.
    • Click "New Pull Request".
    • Provide a clear description of your changes, linking any relevant issues.

🔍 Pull Request Guidelines

  • Keep PRs small and focused—avoid large, unrelated changes.
  • Ensure your code is well-documented—add meaningful comments where necessary.
  • Update relevant documentation if your changes affect existing features.
  • Be open to feedback—reviewers may request changes to improve the quality.

🧑‍💻 Coding Conventions

  • 📌 Follow the existing code style of the project.
  • 📌 Use meaningful variable and function names.
  • 📌 Keep functions small and focused on a single task.
  • 📌 Write clear, concise comments to explain complex logic.

🐞 Reporting Issues

Found a bug or have a suggestion?

  1. Check the GitHub issue tracker to see if the issue already exists.
  2. If not, create a new issue with:
    • A clear description of the problem or suggestion.
    • Steps to reproduce the bug (if applicable).

❓ Questions?

If you have any questions, feel free to:

  • Join our project communication channels.
  • Open an issue on GitHub for clarification.

💙 Thank you for contributing to FundwaveSL! Your support makes this project better. 🚀