Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 2.67 KB

Contributing to CAPT

First off, thank you for considering contributing to CAPT! It's people like you that make CAPT such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include logs and screenshots if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the Go coding style
  • Include tests when adding features
  • End files with a newline
  • Avoid platform-dependent code

Development Process

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Commit Messages

We follow the Conventional Commits specification. This leads to more readable messages that are easy to follow when looking through the project history.

Examples:

feat: add support for Kubernetes v1.20
fix: handle error in cluster creation
docs: update installation guide
style: format code with gofmt
refactor: restructure cluster initialization
test: add test for machine deployment
chore: update dependencies

Testing

  • Write tests for new features
  • Run the test suite before submitting a PR
  • Keep test coverage high

Documentation

  • Update documentation when creating or modifying features
  • Write clear and concise commit messages
  • Comment your code where necessary

License

By contributing to CAPT, you agree that your contributions will be licensed under its MIT License.