CONTRIBUTING.md

Contributing to Dubbo Kubernetes

Dubbo Kubernetes is released under the non-restrictive Apache 2.0 license and follows a very standard GitHub development process, using GitHub tracker for issues and merging pull requests into master. Contributions of all forms to this repository are acceptable, as long as they follow the prescribed community guidelines enumerated below.

Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request (PR), we will need you to sign the Contributor License Agreement. Signing the contributors' agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors may get invited to join the core team, which will grant them privileges to merge existing PRs.

Contact

The mailing list is the recommended way of pursuing a discussion on almost anything related to Dubbo. Please refer to this guide for detailed documentation on how to subscribe.

Mailing Lists

• dev@dubbo.apache.org: The developer mailing list where you can ask questions about issues you may have encountered while working with Dubbo.

  • Subscribe: dev-subscribe@dubbo.apache.org

• commits@dubbo.apache.org: Commit updates will be broadcasted on this mailing list. You can subscribe to it if you are interested in following Dubbo's development.

  • Subscribe: commits-subscribe@dubbo.apache.org

• notifications@dubbo.apache.org: All GitHub issue updates and pull request updates will be sent to this mailing list.

  • Subscribe: notifications-subscribe@dubbo.apache.org

Reporting Issues

Please create an issue here if you encounter any problems or have suggestions for improvements.

Issue Guidelines

• Use a clear and descriptive title
• Provide detailed information about the issue
• Include steps to reproduce the problem
• Add relevant labels if possible
• Reference related issues or pull requests

Submitting Pull Requests

Before Submitting

1. Ensure your code follows the project's coding standards
2. Add tests for new features or bug fixes
3. Update documentation as needed
4. Make sure all tests pass locally

Pull Request Process

1. Fork the repository
2. Create a feature branch from master
3. Make your changes
4. Commit your changes with clear commit messages
5. Push to your fork and create a pull request
6. Ensure all CI checks pass
7. Address any review comments

Commit Message Guidelines

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Code Style

• Follow Go code style guidelines
• Run go fmt before committing
• Ensure go vet passes without errors
• Add appropriate comments for exported functions and types

Development Setup

Please refer to the project's README.md for instructions on setting up your development environment.

Questions?

If you have any questions about contributing, please feel free to reach out via:

• The developer mailing list: dev@dubbo.apache.org
• GitHub Issues: https://github.com/apache/dubbo-kubernetes/issues

Thank you for contributing to Dubbo Kubernetes!