Contribution Guidelines

Sponge is an open-source project, and your contributions are very welcome! Whether submitting bug reports, improving documentation, fixing bugs, or contributing new features, your participation will make sponge better. Please follow these guidelines:

Reporting Bugs

If you encounter a bug while using sponge, please submit it via GitHub Issues. A good bug report should include the following information:

1. The version of the sponge framework you are using.
2. Your Go version and operating system.
3. Detailed steps to reproduce the bug.
4. What was the expected result?
5. What actually happened?
6. Relevant error logs or stack trace information (please format using code blocks).
7. If possible, provide a minimal reproducible example project.

Before submitting, please search the existing Issues to see if someone has already reported a similar problem.

Submitting Pull Requests

The process for contributing code is as follows:

1. Fork the sponge repository to your GitHub account.
2. Clone your Fork locally.
3. Create a new feature branch (git checkout -b feature/your-feature-name or bugfix/your-bugfix-name).
4. Write code on the new branch. Please ensure your code style conforms to project standards, execute the command make ci-lint to check code style.
5. Write corresponding test cases and ensure all tests pass (go test ./...).
6. Commit your changes (git commit -m "feat: add new feature" or fix: fix bug #XYZ"). Please use clear Commit messages.
7. Push your local branch to your Forked repository (git push origin feature/your-feature-name).
8. Open your Forked repository page on GitHub and create a Pull Request (PR) to the main (or develop, depending on the project's branching strategy) branch of the main repository.
9. Clearly describe your changes in the PR description, explaining what problem is solved or what feature is added. If the PR is related to an Issue, mention it in the description (e.g., "Fixes #XYZ" or "Resolves #XYZ").
10. Maintainers will review your PR and may suggest modifications. Please cooperate actively to complete the changes.

Development Process

The development process is as follows:

1. Find the issue you want to solve or the new feature you want to propose in GitHub Issues. If you are proposing a new feature, please first discuss its feasibility via WeChat, Issues, or Discussions.
2. Communicate with project maintainers to ensure your proposal aligns with the project direction.
3. Follow the steps in Submitting Pull Requests for code development, testing, and submission.
4. Participate in the PR review process and refine the code.
5. Once your PR is approved and merged, your contribution is officially part of the project!