diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8ae690b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +# Contributing to Hysteria2 Panel + +Thank you for your interest in contributing to Hysteria2 Panel! We appreciate your help in making this project better. + +## Getting Started + +1. **Fork the repository** on GitHub +2. **Clone your fork** locally + ``` + git clone https://github.com/ReturnFI/Hysteria2.git + cd Hysteria2 + ``` +3. **Create a new branch** for your feature or bugfix + ``` + git checkout -b feature/your-feature-name + ``` + +## Development Workflow + +1. **Make your changes** +2. **Test your changes** thoroughly +3. **Commit your changes** with a clear and descriptive commit message + ``` + git commit -m "Add feature: description of changes" + ``` +4. **Push to your fork** + ``` + git push origin feature/your-feature-name + ``` +5. **Create a Pull Request** from your fork to the main repository + +## Pull Request Guidelines + +- PRs should focus on a single feature or fix +- Include a clear description of the changes and their purpose +- Make sure all tests pass +- Follow the existing code style and conventions +- Keep PRs reasonably sized - split large changes into multiple PRs if necessary + +## Code Style + +- Follow the existing code style in the project +- Use meaningful variable and function names +- Include comments where necessary +- Write clear, concise commit messages + +## Reporting Issues + +If you find a bug or have a suggestion for improvement: + +1. Check the [Issues](https://github.com/ReturnFI/Hysteria2/issues) page to see if it has already been reported +2. If not, create a new issue with: + - A clear title + - A detailed description + - Steps to reproduce (for bugs) + - Expected and actual behavior (for bugs) + +## Security Issues + +Please do not report security vulnerabilities through public GitHub issues. Instead, follow the instructions in our [Security Policy](SECURITY.md). + +## Release Process + +We only support the latest release of Hysteria2 Panel. All contributions will be incorporated into the next release. + +## Questions? + +If you have any questions about contributing, please contact us at ReturnFI@proton.me. + +Thank you for contributing to Hysteria2 Panel!