Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

74 lines (54 loc) · 2.67 KB
Raw

Contributing to K8sToolbox

Thank you for considering contributing to K8sToolbox! Your contributions help make this project even better for the community. Whether you're fixing a bug, adding new features, or improving documentation, all contributions are welcome.

How to Contribute

1. Fork the Repository

First, fork the repository to create your own copy.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/your-username/K8sToolbox.git
cd K8sToolbox

3. Create a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name

Use a descriptive branch name, such as bugfix/fix-network-tool or feature/add-new-debug-command.

4. Make Your Changes

Make the necessary changes to the codebase. If you're adding a new feature or fixing a bug, ensure you:

  • Write clean, readable, and well-documented code.
  • Update or add unit tests for the changes where applicable.

5. Test Your Changes

Make sure your changes pass all existing tests, and add new tests if applicable.

  • Run the test suite to verify that everything works as expected.

6. Commit Your Changes

Once you're satisfied with your changes, commit them:

git add .
git commit -m "Add a description of your changes"

7. Push to Your Fork

Push the changes to your forked repository:

git push origin feature/your-feature-name

8. Open a Pull Request

Go to the original repository on GitHub and open a pull request:

  • Click on the "Compare & pull request" button.
  • Provide a clear title and description for your pull request.
  • Reference any related issues in the description.

9. Participate in the Review

A project maintainer will review your pull request. You may be asked to make additional changes, so stay updated on the review and provide revisions as needed.

Code Style and Guidelines

  • Follow the existing code style used in the repository.
  • Write concise and descriptive commit messages.
  • Document your code where necessary, especially for new features.

Issues and Feature Requests

  • If you find a bug or have an idea for a new feature, feel free to open an issue.
  • When reporting a bug, please include detailed information, steps to reproduce, and the expected behavior.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for your contributions and for being part of the K8sToolbox community!