71 lines (52 loc) · 1.86 KB

Contributing to k8dev

Welcome

Thank you for considering contributing to k8dev. This tool aims to simplify local development workflows, and your input can help make it even better.

Getting Started

Set up your environment:
- Install Rancher Desktop
- Clone the repository
- Run make install to set up k8dev
Familiarize yourself with the project:
- Review the README
- Try the basic commands
- Understand the project structure

Development Process

Fork the Repository
- Create your feature branch from main
- Use clear, descriptive branch names (e.g., feature/add-redis-support)
Make Your Changes
- Follow existing code style and conventions
- Keep changes focused and minimal
- Add or update documentation as needed
- Add comments for complex logic
Test Your Changes
- Ensure existing functionality works
- Test on both macOS and Linux if possible
- Verify Helm charts and values work correctly
Submit a Pull Request
- Provide a clear description of the changes
- Link any related issues
- Include steps to test the changes
- List any new dependencies

Code Guidelines

Keep scripts modular and reusable
Use meaningful variable and function names
Add comments for non-obvious functionality
Follow shell scripting best practices

Documentation

Good documentation is as important as good code:

Update README if adding new features
Include examples for new functionality
Document any breaking changes
Keep configuration examples up to date

Questions and Discussion

If you have questions or ideas:

Open a GitHub issue for discussion
Provide context and examples
Be respectful and constructive

Need Help?

If you need help or clarification:

Check existing documentation
Look through closed issues
Open a new issue with your question

Thank you for contributing to k8dev!