Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 2.75 KB

Contributing to GoKubeBalancer

Thank you for considering contributing to GoKubeBalancer! Your contributions help improve the project and benefit the community. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository

    Start by forking the GoKubeBalancer repository to your own GitHub account. This allows you to freely make changes without affecting the original project.

  2. Clone Your Fork

    Clone your forked repository to your local machine:

    git clone https://github.com/your-username/GoKubeBalancer.git

  3. Create a New Branch

    Create a new branch for your changes. Use a descriptive name for the branch that reflects the purpose of your changes:

    git checkout -b feature/your-feature-name

  4. Make Your Changes

    Implement your changes or new features. Make sure to write clear and concise commit messages explaining what you’ve done.

  5. Run Tests

    Ensure that all existing and new tests pass before submitting your changes. This helps maintain the integrity of the project.

  6. Commit and Push

    Commit your changes and push them to your forked repository:

    git add .
git commit -m "Add a descriptive commit message"
git push origin feature/your-feature-name

  7. Create a Pull Request

    Go to the original GoKubeBalancer repository and open a pull request from your branch. Provide a clear description of your changes and why they are being made.

  8. Pull Request Guidelines

    • Describe the Problem: Clearly explain the issue or feature being addressed in the pull request description.
    • Provide Context: Include any relevant context or background information that might help the reviewers understand your changes.
    • Reference Issues: If your pull request addresses an open issue, reference it in the description (e.g., "Fixes #42").
    • Follow Code Style: Adhere to the coding style used in the project. Consistent code style helps maintain readability.
    • Include Tests: If your changes introduce new features or modify existing functionality, include appropriate tests.

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on the GitHub repository. Provide detailed information about the problem, including steps to reproduce, screenshots, or error messages if applicable.

Code of Conduct

By participating in this project, you agree to adhere to our Code of Conduct. We are committed to creating a welcoming and inclusive environment for all contributors.

Additional Resources