Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 2.78 KB
Raw

Contributing to install-k8s-on-linux

Thank you for considering contributing to this project! We welcome all forms of contributions and appreciate your efforts. Please take a moment to review this guide before you start contributing.

How Can You Contribute?

1. Reporting Bugs

If you find any bugs, please report them by opening an issue in the Issues section. Include the following:

  • A clear and descriptive title.
  • A detailed description of the problem, including steps to reproduce the issue.
  • The version of the project you're using, operating system, and other relevant information.

2. Suggesting Features or Enhancements

If you have ideas for improving the project, feel free to submit feature requests or suggestions by opening an issue. Please include:

  • A description of the feature and why it would be beneficial.
  • Any implementation details or relevant resources, if applicable.

3. Submitting Code

We welcome code contributions. Here’s how to get started:

  • Fork the repository and create your branch from main (e.g., git checkout -b feature-branch).
  • Ensure your code is well-documented and follows the project's coding standards.
  • Add or update documentation as necessary.
  • Commit your changes (e.g., git commit -m 'Add feature X').
  • Push your branch to GitHub (e.g., git push origin feature-branch).
  • Open a pull request (PR) with a clear description of the changes.

4. Improving Documentation

Documentation improvements are always welcome. If you find areas in the documentation that need updates or missing sections, feel free to contribute. You can:

  • Submit issues with suggestions or open a pull request to update the README.md, CONTRIBUTING.md, or other documentation files.

Code Style and Guidelines

To keep the codebase clean and easy to maintain, please follow these guidelines:

  • Write clear and self-explanatory comments in your code.
  • Maintain consistent formatting and naming conventions throughout the codebase.

Commit Messages

  • Use clear and concise commit messages.
  • Follow this format if possible:
    • feat: New feature
    • fix: Bug fix
    • docs: Documentation changes
    • style: Code style changes (white-space, formatting, etc.)
    • refactor: Code restructuring
    • test: Adding or modifying tests

Code of Conduct

By contributing to this project, you agree to follow our Code of Conduct.

Getting Help

If you have any questions or need assistance, feel free to reach out via the Issues or start a discussion.

We appreciate your contributions and your effort to make this project better! 😊