Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (83 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

130 lines (83 loc) · 3.8 KB
Raw

Contributing to VoidSwift

First off, thank you for your interest in contributing to VoidSwift! ❤️

Whether you're fixing bugs, improving documentation, or adding new features, every contribution helps make the project better. Please read these guidelines before getting started.

Getting Started

  1. Fork the repository.
  2. Clone your fork locally.
  3. Create a new branch from the default branch.
  4. Make your changes.
  5. Test your changes (if applicable).
  6. Commit your changes with a clear commit message.
  7. Push your branch and open a Pull Request.

Before You Start

  • Search existing issues before opening a new one.
  • If you're planning a large feature or significant change, open an issue first so we can discuss the best approach.
  • Keep each Pull Request focused on a single feature or fix.
  • Read this document completely before contributing.

Contribution Limits

To keep contributions active and ensure everyone gets a chance to contribute:

  • A contributor may have up to 3 assigned issues at any given time.
  • A contributor may have up to 3 open Pull Requests at any given time.
  • If you are unable to continue working on an assigned issue, please let us know so it can be reassigned.
  • Issues that remain inactive for 2-3 days without any progress or updates may be unassigned.
  • Pull Requests that remain inactive for 2-3 days without responding to review comments or showing progress may be closed.

Waiting for Review?

If your Pull Request is waiting for a maintainer's review and you haven't received any response within 2-3 days, please join our VoidSwift Discord and politely ping a Maintainer or Project Admin. This helps ensure your PR isn't accidentally missed.

Pull Request Guidelines

Before opening a Pull Request, please ensure that:

  • Your PR solves only one issue or introduces one feature.

  • Your branch is up to date with the default branch.

  • Your commit messages are meaningful and descriptive.

  • You link related issues using:

    • Closes #123
    • Fixes #123

  • You update documentation if your changes require it.

  • Your code follows the project's existing style.

  • Your PR is ready for review.

Code Style

Please follow the existing coding style of the project.

  • Write clean and readable code.
  • Avoid unnecessary refactoring.
  • Keep changes focused.
  • Add tests whenever possible, especially for bug fixes.
  • Remove debugging code before submitting your PR.

Good First Contributions

If you're new to the project, look for issues labeled:

  • good first issue
  • help wanted

These issues are intended for new contributors.

Reporting Bugs

When opening a bug report, please include:

  • Clear description of the issue.
  • Steps to reproduce.
  • Expected behavior.
  • Actual behavior.
  • Screenshots or logs (if applicable).
  • Environment details (OS, version, etc.).

Feature Requests

Before requesting a feature:

  • Check existing issues to avoid duplicates.
  • Clearly explain the problem you're trying to solve.
  • Describe your proposed solution.
  • Include any additional context if needed.

Community

For discussions, support, announcements, and faster communication, please join the VoidSwift Discord.

If you're actively contributing, we highly recommend joining the Discord server so maintainers can communicate with you easily regarding reviews, changes, or issue assignments.

Code of Conduct

Please be respectful, constructive, and welcoming.

Harassment, abusive language, spam, or toxic behavior will not be tolerated. We want VoidSwift to be a friendly and inclusive community for everyone.

Thank You ❤️

Every contribution, whether it's code, documentation, bug reports, or suggestions, helps improve VoidSwift.

Thank you for being part of our community. Happy coding! 🚀